|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractAttrGroupDef | +--com.ibm.mm.sdk.common.DKAttrGroupDefICM
DKAttrGroupDefICM : This class is used to represent attribute group definition in Content Manager server. An attribute group is composed of several related individual attributes that must exist together as a group. For example, the attribute group Address can be defined to contain attributes StreetAddress, City, and ZipCode. These attributes must be defined together as a group in order to make the definition valid. As a regular attribute, an attribute group has basic properties, such as, name, description, and so forth. Persistent operations on attribute group definition are also supported via add, update, and delete methods. This class has methods to manage the list of attributes belong to this group. Reference attributes are represented using this attribute group class. When defining an item-type, you can include attribute groups as well as regular attributes. See related classes DKAttrDefICM, DKItemTypeDefICM, and DKItemTypeViewDefICM. Since Version 8
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKAttrGroupDefICM()
The default constructor for constructing an attribute group |
|
DKAttrGroupDefICM(DKAttrGroupDefICM group)
A copy constructor for attribute group definition for ICM datastore. |
|
DKAttrGroupDefICM(dkDatastore ds)
Constructs an attribute group definition for the given ICM datastore |
|
DKAttrGroupDefICM(dkDatastore ds,
int opt)
Constructs an attribute group definition for the given ICM datastore |
Method Summary | |
void |
add()
Adds this attribute group defintion to the persistent store |
void |
addAttr(dkAttrDef attr)
Adds a new attribute to this attribute group. |
void |
del()
Deletes this attribute group definition from the persistent store. |
int |
getAttrCount()
Gets the number of attributes in this attribute group |
java.lang.String |
getDescription()
Gets the description of this attribute group |
java.lang.String |
getDescription(java.lang.String langCode)
Gets the description of this attribute group in the given language. |
int |
getID()
Gets this attribute group identifier |
short |
getRefDeleteRule()
Gets the delete rule for this reference attribute group |
int |
getReferenceSequenceNumber()
Gets the first sequence number for this reference attribute group. |
boolean |
isReferenceAttributeGroup()
Checks if this attribute group is a reference attribute. |
java.lang.String[] |
listAttrNames()
Lists the names of attribute defined in the attribute group. |
java.lang.String[] |
listAttrNames(int option)
Lists the names of attribute defined in this attribute group filterd according to the specified options. |
dkCollection |
listAttrs()
List attributes defined in this attribute group |
dkCollection |
listAttrs(int option)
List attributes defined in this attribute group filtered according to the specified option. |
void |
removeAttr(java.lang.String attrName)
Removes the specified attribute from this attribute group. |
void |
setDescription(java.lang.String descrip)
Sets the description for this attribute group the language code for this method is 'ENU' |
void |
setDescription(java.lang.String desc,
java.lang.String langCode)
Sets the description of this attribute group for the given language. |
void |
setID(int id)
Sets the attribute group identifier |
void |
setRefDeleteRule(short refDeleteRule)
Sets the reference delete rule for this reference attribute group The reference delete rule governs the action to be done to the target reference when the instance of the component having this reference attribute (or source reference) is deleted. |
void |
setReferenceSequenceNumber(int seqNo)
Set the first sequence number for this reference attribute group. |
void |
update()
Updates this attribute group definition in the persistent store You can not update an attribute group if it is already associated with an item-type. |
void |
updateAttr(dkAttrDef def)
Updates the definition of the given attribute in this attribute group. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAttrGroupDef |
clearCache, datastoreType, getDatastore, getName, setDatastore, setName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKAttrGroupDefICM()
public DKAttrGroupDefICM(dkDatastore ds)
ds
- the ICM datastorepublic DKAttrGroupDefICM(dkDatastore ds, int opt)
ds
- - the ICM datastoreoption
- to indicate if this attribute group is a reference attribute. The caller
need to set this option value to DKConstantICM.DK_ICM_REFERENCE_ATTRGROUP to specify
that this attribute is a reference attribute. This is the way to create a reference
attribute.
The default is a regular attribute group, not a reference attribute, so in this case
the other two constructors can be used instead.public DKAttrGroupDefICM(DKAttrGroupDefICM group)
an
- DKAttrGroupDefICM objectMethod Detail |
public void add() throws DKException, java.lang.Exception
if
- there is no attribute defined in this attribute group.public void del() throws DKException, java.lang.Exception
if
- user tried to delete an attribute group that associates
with an item typepublic void update() throws DKException, java.lang.Exception
if
- user tried to update an attribute group that assoicates with
an item type or user tried to add or remove attribute from this attribute group.public int getAttrCount() throws DKException, java.lang.Exception
if
- attribute group doesn't exist in persistent store.public int getID()
public void setID(int id)
id,
- the identifier of this attribute grouppublic java.lang.String getDescription()
public void setDescription(java.lang.String descrip) throws DKException, java.lang.Exception
descrip,
- the description to be assigned to this attribute groupif
- the length of this attribute group description exceeds 254 characters.public java.lang.String getDescription(java.lang.String langCode) throws DKException, java.lang.Exception
langCode,
- the language code
The valid language codes are:
"AFR", "ARA", "BEL", "BGR", "CAT", "CHT", "CHS", "CSY",
"CZE", "DAN", "DEU", "DES", "ELL", "ENA", "ENG", "ENU",
"FRB", "FRC", "ENP", "ESP", "FIN", "FRA", "FRS", "GAE",
"HEB", "HRV", "HUN", "ISL", "ITA", "ITS", "JPN", "KOR",
"MKD", "NLD", "NLB", "NON", "NOR", "PLK", "PTB", "PTG",
"RMS", "ROM", "RUS", "SKY", "SLO", "SQI", "SRB", "SRL",
"SVE", "THA", "TRK", "UKR", "URD"public void setDescription(java.lang.String desc, java.lang.String langCode) throws DKException, java.lang.Exception
langCode,
- the language codedesc,
- the description of this attribute groupif
- the length of this attribute group description exceeds 254 characters.public dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractAttrGroupDef
if
- the attribute group doesn't exist in the persistent storepublic dkCollection listAttrs(int option) throws DKException, java.lang.Exception
if
- the attribute group doesn't exist in the persistent storepublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractAttrGroupDef
if
- the attribute group doesn't exist in the persistent store.public java.lang.String[] listAttrNames(int option) throws DKException, java.lang.Exception
if
- this attribute group doesn't exist in the persistent storepublic void addAttr(dkAttrDef attr) throws DKAlreadyExistException, DKException, java.lang.Exception
addAttr
in class dkAbstractAttrGroupDef
attr
- A DKAttrDefICM objectDKAlreadyExistException
- if the attribute already exists in the attribute grouppublic void updateAttr(dkAttrDef def) throws DKException, java.lang.Exception
attr
- A DKAttrDefICM objectif
- the attribute doesn't exist in this attribute group.public void removeAttr(java.lang.String attrName) throws DKNotExistException, DKException
removeAttr
in class dkAbstractAttrGroupDef
attrName
- name of the attribute need to be removedDKNotExistException
- if the attribute name does not exists in
this attribute grouppublic int getReferenceSequenceNumber()
setReferenceSequenceNumber(int)
public void setReferenceSequenceNumber(int seqNo)
seqNo
- the sequence numberpublic boolean isReferenceAttributeGroup()
public short getRefDeleteRule()
setRefDeleteRule(short)
public void setRefDeleteRule(short refDeleteRule)
refDeleteRule
- reference delete rule
The possible values are:
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |