com.softwareag.centrasite.appl.framework.types
Interface Profile

All Known Implementing Classes:
ProfileImpl

public interface Profile

Java bean interface representing CentraSite profile. A profile serves as a container of attributes. Profiles are usually associated with types.

Since:
CentraSite 8.0

Field Summary
static java.lang.String KEY_GENERIC_PROFILE_Assocations
          Keys of generic profiles.
static java.lang.String KEY_GENERIC_PROFILE_AuditLog
           
static java.lang.String KEY_GENERIC_PROFILE_Classifications
           
static java.lang.String KEY_GENERIC_PROFILE_Consumers
           
static java.lang.String KEY_GENERIC_PROFILE_ExternalLinks
           
static java.lang.String KEY_GENERIC_PROFILE_Notifications
           
static java.lang.String KEY_GENERIC_PROFILE_ObjectSpecificProperties
           
static java.lang.String KEY_GENERIC_PROFILE_Permissions
           
static java.lang.String KEY_GENERIC_PROFILE_Versions
           
static java.lang.String SLOT_ATTRIBUTES
          Name of the Slot storing associated with the profile attribute names.
static java.lang.String SLOT_PROFILE_ID
          Name of the Slot storing the profile sequence number.
 
Method Summary
 void addAttribute(AttributeDescription attribute)
          Adds an attribute to the given profile.
 java.util.Collection<java.lang.String> getAttributeNames()
          Retrieves all names of attributes associated with th profile.
 java.util.Collection<AttributeDescription> getAttributes()
          Gets all attributes of the profile.
 java.lang.String getDescription()
          Returns the registry objects description.
 java.lang.String getKey()
          Retrieves the key of this profile object.
 java.lang.String getName()
          Returns the registry objects name.
 int getSequenceNumber()
          Retrieves this profiles's sequence number inside the type it belongs to.
 boolean isPredefined()
          Checks if this profile is one of the predefined ones.
 void removeAttribute(AttributeDescription attribute)
          Removes an attribute from the given profile.
 void setDescription(java.lang.String pDescription)
          Sets the registry objects description.
 void setName(java.lang.String pName)
          Sets the registry objects name.
 

Field Detail

SLOT_PROFILE_ID

static final java.lang.String SLOT_PROFILE_ID
Name of the Slot storing the profile sequence number.

See Also:
Constant Field Values

SLOT_ATTRIBUTES

static final java.lang.String SLOT_ATTRIBUTES
Name of the Slot storing associated with the profile attribute names.

See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Assocations

static final java.lang.String KEY_GENERIC_PROFILE_Assocations
Keys of generic profiles.

See Also:
Constant Field Values

KEY_GENERIC_PROFILE_AuditLog

static final java.lang.String KEY_GENERIC_PROFILE_AuditLog
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Classifications

static final java.lang.String KEY_GENERIC_PROFILE_Classifications
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Consumers

static final java.lang.String KEY_GENERIC_PROFILE_Consumers
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_ExternalLinks

static final java.lang.String KEY_GENERIC_PROFILE_ExternalLinks
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Notifications

static final java.lang.String KEY_GENERIC_PROFILE_Notifications
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_ObjectSpecificProperties

static final java.lang.String KEY_GENERIC_PROFILE_ObjectSpecificProperties
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Permissions

static final java.lang.String KEY_GENERIC_PROFILE_Permissions
See Also:
Constant Field Values

KEY_GENERIC_PROFILE_Versions

static final java.lang.String KEY_GENERIC_PROFILE_Versions
See Also:
Constant Field Values
Method Detail

getKey

java.lang.String getKey()
                        throws CSAppFrameworkException
Retrieves the key of this profile object.

Returns:
uddi key
Throws:
CSAppFrameworkException

getSequenceNumber

int getSequenceNumber()
                      throws CSAppFrameworkException
Retrieves this profiles's sequence number inside the type it belongs to.

Returns:
int
Throws:
CSAppFrameworkException

getAttributeNames

java.util.Collection<java.lang.String> getAttributeNames()
                                                         throws CSAppFrameworkException
Retrieves all names of attributes associated with th profile.

Returns:
attribute names
Throws:
CSAppFrameworkException

isPredefined

boolean isPredefined()
                     throws CSAppFrameworkException
Checks if this profile is one of the predefined ones.

Returns:
boolean
Throws:
CSAppFrameworkException

getName

java.lang.String getName()
                         throws CSAppFrameworkException
Returns the registry objects name.

Throws:
CSAppFrameworkException

setName

void setName(java.lang.String pName)
             throws CSAppFrameworkException
Sets the registry objects name.

Throws:
CSAppFrameworkException

getDescription

java.lang.String getDescription()
                                throws CSAppFrameworkException
Returns the registry objects description.

Throws:
CSAppFrameworkException

setDescription

void setDescription(java.lang.String pDescription)
                    throws CSAppFrameworkException
Sets the registry objects description.

Throws:
CSAppFrameworkException

getAttributes

java.util.Collection<AttributeDescription> getAttributes()
                                                         throws CSAppFrameworkException
Gets all attributes of the profile.

Returns:
collection of attributes
Throws:
CSAppFrameworkException

addAttribute

void addAttribute(AttributeDescription attribute)
                  throws CSAppFrameworkException
Adds an attribute to the given profile.

Parameters:
attribute -
Throws:
CSAppFrameworkException

removeAttribute

void removeAttribute(AttributeDescription attribute)
                     throws CSAppFrameworkException
Removes an attribute from the given profile.

Parameters:
attribute -
Throws:
CSAppFrameworkException