dca_wac::WacAction Class Reference
[Web Application Classification (WAC)]

#include <wac_action.h>

List of all members.


Detailed Description

The WacAction class represents a given action of an application e.g. UPLOAD FILE, ADD ATTACHMENT, DOWNLOAD FILE etc.

To retrieve all actions available for a given application use the WacApplication class.

The result of a WAC classification (WacClassificationResult) contains the id of an action if found. With this id you can use a WacActions container class and the method WacActions::byId() to retrieve the WacAction object.

See also:
WacActions, WacCategoriesInfo, WacApplication, WacClassificationResult

Definition at line 30 of file wac_action.h.

Public Member Functions

bool operator== (const WacAction &aInst) const
 Equality operator, returns true if two WacAction objects refer to the identical internal action.
bool operator!= (const WacAction &aInst) const
 Inequality operator, returns true if two WacAction objects refer to different internal actions.
DCA_ACTION_ID_TYPE id () const
 Returns the internal id of a WacAction class.
std::string name (const std::string &localeString=std::string()) const
 Returns the localized (display) name of the action.
std::string description (const std::string &localeString=std::string()) const
 Returns the localized (brief) description of the action.

Member Function Documentation

bool dca_wac::WacAction::operator== ( const WacAction aInst  )  const

Equality operator, returns true if two WacAction objects refer to the identical internal action.

Parameters:
[in] aInst Another WacAction instance to check for equality with current instance.
Returns:
True if identical, otherwise false
See also:
dca_wac::NullWacAction
bool dca_wac::WacAction::operator!= ( const WacAction aInst  )  const

Inequality operator, returns true if two WacAction objects refer to different internal actions.

Parameters:
[in] aInst Another WacAction instance to check for inequality with the current instance.
Returns:
False if identical, otherwise true
See also:
dca_wac::NullWacAction
DCA_ACTION_ID_TYPE dca_wac::WacAction::id (  )  const

Returns the internal id of a WacAction class.

Returns:
The id of the action.
std::string dca_wac::WacAction::name ( const std::string &  localeString = std::string()  )  const

Returns the localized (display) name of the action.

Parameters:
[in] localeString The name of the Locale to be used. Leave blank to use the default locale ("en_US")
Returns:
Localized action name.
Note:
The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.
std::string dca_wac::WacAction::description ( const std::string &  localeString = std::string()  )  const

Returns the localized (brief) description of the action.

Parameters:
[in] localeString The name of the Locale to be used. Leave blank to use the default locale ("en_US")
Returns:
Localized action description.
Note:
The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.

The documentation for this class was generated from the following file:

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1