com.genesyslab.omsdk.qil
Interface BusinessAttribute


public interface BusinessAttribute

Represents a business attribute defined in the Configuration Layer.

This business attribute's properties are read-only objects.

A business attribute is some metadata defined in the configuration Layer for a set of Genesys object. In QIL, business attributes qualify interactions and can be one of the following: Interaction Type, Interaction Subtype, Media Type.

Since:
7.1.000.00
See Also:
QILFactory.getBusinessAttribute(String), QILFactory.getMediaTypes(), QILFactory.getInteractionTypes(), QILFactory.getInteractionSubtypes()

Method Summary
 java.util.Map getAnnex()
          Returns the Annex options defined for this business attribute.
 java.lang.String getDescription()
          Returns this business attribute's description.
 java.lang.String getDisplayName()
          Returns this business attribute's display name.
 java.lang.String getName()
          Returns this business attribute's name.
 BusinessAttributeType getType()
          Returns this business attribute's type.
 BusinessAttributeValue getValue(java.lang.String name)
          Returns this business attribute's value associated with the specified name (if any); otherwise null.
 java.util.Collection getValues()
          Returns this business attribute's values.
 

Method Detail

getValues

public java.util.Collection getValues()
Returns this business attribute's values.

Returns:
Collection of BusinessAttributeValue.

getDescription

public java.lang.String getDescription()
Returns this business attribute's description. The description corresponds to the Description property defined in the Configuration Layer.

Returns:
Description of this business attribute

getName

public java.lang.String getName()
Returns this business attribute's name. The description corresponds to the Name property defined in the Configuration Layer.

Returns:
this business attribute's name

getDisplayName

public java.lang.String getDisplayName()
Returns this business attribute's display name. The description corresponds to the Display Name property defined in the Configuration Layer.

Returns:
this business attribute's display name

getAnnex

public java.util.Map getAnnex()
Returns the Annex options defined for this business attribute.
The returned collection is a copy of the original options and does not reflect changes that can occur after calling this method.

Returns:
annex as a Map, where the key is a String for a section name, and the value is a second-level Map of options.
In the second-level Map, the key is a String for an option name and the value is a String for the corresponding option value.

getType

public BusinessAttributeType getType()
Returns this business attribute's type.

Returns:
the business attribute's type.

getValue

public BusinessAttributeValue getValue(java.lang.String name)
Returns this business attribute's value associated with the specified name (if any); otherwise null.

Parameters:
name - name of the business attribute's value.
Returns:
BusinessAttributeValue associated with the specified name (if any); otherwise null.
Since:
7.1.004.00
See Also:
BusinessAttributeValue.getName()