dca_interface  6.3.4
wac_action.h
Go to the documentation of this file.
1 /* IBM Source Code */
2 /* (C) Copyright IBM Corp. 2009, 2012 */
3 /* Licensed Materials - Property of IBM */
4 /* US Government Users Restricted Rights - Use duplication or disclosure restricted by GSA Schedule Contract with IBM Corp. */
5 
6 #ifndef WAC_ACTION_H
7 #define WAC_ACTION_H
8 
14 namespace dca_wac {
15 
16  class wacaction_p;
17 
30  class WacAction {
31  public:
33  WacAction();
34  WacAction( const WacAction& aAction );
35  WacAction& operator = ( const WacAction& aAction );
36  virtual ~WacAction();
38 
45  bool operator == ( const WacAction& aInst ) const;
46 
53  bool operator != ( const WacAction& aInst ) const;
54 
60 
67  std::string name( const std::string& localeString = std::string() ) const;
68 
75  std::string description( const std::string& localeString = std::string() ) const;
76 
78  PRIVATE_PTR wacaction_p *_p;
79  };
80 
87  extern WacAction NullWacAction;
88 }
89 
90 #endif
DCA_ACTION_ID_TYPE id() const
Returns the internal id of a WacAction class.
bool operator==(const WacAction &aInst) const
Equality operator, returns true if two WacAction objects refer to the identical internal action.
int DCA_ACTION_ID_TYPE
Type for action ids.
Definition: base_types.h:42
bool operator!=(const WacAction &aInst) const
Inequality operator, returns true if two WacAction objects refer to different internal actions.
The WacAction class represents a given action of an application e.g. UPLOAD FILE, ADD ATTACHMENT,...
Definition: wac_action.h:30
std::string description(const std::string &localeString=std::string()) const
Returns the localized (brief) description of the action.
std::string name(const std::string &localeString=std::string()) const
Returns the localized (display) name of the action.
WacAction NullWacAction
Defines a constant unassigned WacAction you can use for checks. if( myWacAction == NullWacAction ) --...
#define PRIVATE_PTR
Type for private pointer implementations, for internal use only.
Definition: base_types.h:83