com.ibm.pim.spec
Interface PrimarySpec
- All Superinterfaces:
- Spec
public interface PrimarySpec
- extends Spec
Interface for the PrimarySpec object
- Since:
- 6.0.0
Nested classes/interfaces inherited from interface com.ibm.pim.spec.Spec |
Spec.Type |
Field Summary |
static java.lang.String |
copyright
|
Methods inherited from interface com.ibm.pim.spec.Spec |
addLocale, createAttributeDefinition, delete, getAttributeDefinition, getAttributeDefinitions, getLocales, getName, getRootAttributeDefinition, getType, isLocalized, removeAttributeDefinition, removeLocale, replaceLocales, save, setLocalized |
copyright
static final java.lang.String copyright
- See Also:
- Constant Field Values
getPrimaryKeyAttributeDefinition
AttributeDefinition getPrimaryKeyAttributeDefinition()
- Returns the primary key AttributeDefinition for this PrimarySpec
- Returns:
- AttributeDefinition the primary key AttributeDefinition for this
LookupSpec
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
hasSubSpec
boolean hasSubSpec()
- Returns true if this primary spec has a subspec
- Returns:
- true if subspec is present
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
setPrimaryKey
AttributeDefinition setPrimaryKey(java.lang.String attributePath)
- Sets the primaryKeyPath of this spec to the given path. Returns null if
primary key with given path is not found.
- Parameters:
attributePath
- value for the path
- Returns:
- AttributeDefinition AttributeDefinition corresponding to the
primary key
- Throws:
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If null or empty attributePath is passed