com.ibm.pim.catalog
Interface LocationDataConfiguration


public interface LocationDataConfiguration

Describes the Location Configuration in the form of a Hierarchy and SecondarySpec. Multiple instances can exist per Catalog. With the exception of delete, no authorization checks occur on this object as these will have been made at the parent level

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          delete the relationship from the catalog
 java.util.List<AttributeCollection> getAttributeCollections()
          Retrieves inheritance Attribute Collections for this particular Configuration.
 Catalog getCatalog()
          Retrives the Parent Catalog
 Hierarchy getHierarchy()
          Retrieves the Hierarchy for this particular Configuration
 SecondarySpec getSpec()
          Retrieves the Spec for this particular Configuration
 void setAttributeCollections(java.util.List<AttributeCollection> attributes)
          Sets inheritance Attribute Collections for this particular Configuration.
 

Field Detail

copyright

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

delete

void delete()
delete the relationship from the catalog

Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalStateException - If the object is in an invalid state
PIMAuthorizationException - If the user lacks the equivalent of: com.ibm.pim.organization.Permission#CATALOG_ATTRIBUTES}

getCatalog

Catalog getCatalog()
Retrives the Parent Catalog

Returns:
Catalog Object
Throws:
java.lang.IllegalStateException - If the object is in an invalid state
PIMInternalException - If an internal error occurs

getHierarchy

Hierarchy getHierarchy()
Retrieves the Hierarchy for this particular Configuration

Returns:
Hierarchy Object
Throws:
java.lang.IllegalStateException - If the object is in an invalid state
PIMInternalException - If an internal error occurs

getSpec

SecondarySpec getSpec()
Retrieves the Spec for this particular Configuration

Returns:
Secondary Spec Object
Throws:
java.lang.IllegalStateException - If the object is in an invalid state
PIMInternalException - If an internal error occurs

getAttributeCollections

java.util.List<AttributeCollection> getAttributeCollections()
Retrieves inheritance Attribute Collections for this particular Configuration.

Returns:
A list of AttributeCollections
Throws:
java.lang.IllegalStateException - If the object is in an invalid state
PIMInternalException - If an internal error occurs

setAttributeCollections

void setAttributeCollections(java.util.List<AttributeCollection> attributes)
Sets inheritance Attribute Collections for this particular Configuration.

Parameters:
attributes - A List of attribute collections
Throws:
PIMInternalException - If an internal error occurs