Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

ResourceAttributeDefinition Class Reference

Allows the developer to be able to add more customization for resource attributes used within preference expressions. More...

List of all members.


Public Methods

 ResourceAttributeDefinition (const SoamChar *name, const SoamChar *alias)
 Construct a definition.

 ResourceAttributeDefinition (const SoamChar *name, const SoamChar *alias, SoamDouble defaultValue)
 Construct a definition.

 ResourceAttributeDefinition (const std::string &name, const std::string &alias)
 Construct a definition.

 ResourceAttributeDefinition (const std::string &name, const std::string &alias, SoamDouble defaultValue)
 Construct a definition.

virtual ~ResourceAttributeDefinition ()
 Destructor.


Friends

class SessionCreationAttributes
class ResourcePreference

Detailed Description

Allows the developer to be able to add more customization for resource attributes used within preference expressions.

Definitions are optional and are required only in the following cases:

  1. The attribute in the expression has a different name than the attribute which will be published to the application.
  2. The attribute in the expression deserves a special default value that cannot be satisfied by either the session level or system default values.
NOTE: If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).


Constructor & Destructor Documentation

ResourceAttributeDefinition const SoamChar *    name,
const SoamChar *    alias
 

Construct a definition.

Parameters:
name  [IN] - The name of the attribute that will be published by the application. It can be the same or different from the alias parameter and can contain characters that are not allowed within the preference expression. The name cannot exceed a 256 character length.
alias  [IN] - The alias to be associated with the attribute. The alias can be considered the "formal" name of the attribute. It can be the same as or different from the name parameter. The alias can only contain alpha numeric and underscore characters and cannot exceed a 32 character length.

ResourceAttributeDefinition const SoamChar *    name,
const SoamChar *    alias,
SoamDouble    defaultValue
 

Construct a definition.

Parameters:
name  [IN] - The name of the attribute that will be published by the application. It can be the same or different from the alias parameter and can contain characters that are not allowed within the preference expression. The name cannot exceed a 256 character length.
alias  [IN] - The alias to be associated with the attribute. The alias can be considered the "formal" name of the attribute. It can be the same as or different from the name parameter. The alias can only contain alpha numeric and underscore characters and cannot exceed a 32 character length.
defaultValue  [IN] - The default value to be assigned to this resource attribute in the event that the system cannot find a value that was published within the context of a specific resource.

ResourceAttributeDefinition const std::string &    name,
const std::string &    alias
 

Construct a definition.

Parameters:
name  [IN] - The name of the attribute that will be published by the application. It can be the same or different from the alias parameter and can contain characters that are not allowed within the preference expression. The name cannot exceed a 256 character length.
alias  [IN] - The alias to be associated with the attribute. The alias can be considered the "formal" name of the attribute. It can be the same as or different from the name parameter. The alias can only contain alpha numeric and underscore characters and cannot exceed a 32 character length.

ResourceAttributeDefinition const std::string &    name,
const std::string &    alias,
SoamDouble    defaultValue
 

Construct a definition.

Parameters:
name  [IN] - The name of the attribute that will be published by the application. It can be the same or different from the alias parameter and can contain characters that are not allowed within the preference expression. The name cannot exceed a 256 character length.
alias  [IN] - The alias to be associated with the attribute. The alias can be considered the "formal" name of the attribute. It can be the same as or different from the name parameter. The alias can only contain alpha numeric and underscore characters and cannot exceed a 32 character length.
defaultValue  [IN] - The default value to be assigned to this resource attribute in the event that the system cannot find a value that was published within the context of a specific resource.

virtual ~ResourceAttributeDefinition   [virtual]
 

Destructor.



     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.