|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.bct.rp.cms.OrgEntityXML
The class OrgEntityXML
contains methods for performing basic
operations on OrgEntity objects in the WebSphere Member Subsystem.
Constructor Summary | |
OrgEntityXML()
Blank OrgEntityXML constructor. |
|
OrgEntityXML(com.ibm.bct.rp.cms.OrgEntityVO orgVO)
OrgEntityXML constructor from OrgEntityVO object. |
|
OrgEntityXML(java.lang.String theXML)
OrgEntityXML constructor from XML attribute definition. |
|
OrgEntityXML(java.lang.String theIiopNode,
java.lang.String orgEntityId)
OrgEntityXML constructor from existing OrgEntity CMS record. |
|
OrgEntityXML(java.lang.String theIiopNode,
java.lang.String interchangeType,
java.lang.String interchangeId)
OrgEntityXML constructor from existing OrgEntity CMS record. |
Method Summary | |
java.lang.String |
createOrgEntity()
Create an OrgEntity in WMS based on attributes in this OrgEntity object. |
void |
deleteOrgEntity(boolean includeDescendants)
Delete an OrgEntity from WMS represented by this OrgEntity object. |
java.util.List |
findOrgEntities(java.lang.String attrName,
java.lang.String attrValue)
Find all OrgEntities based on an attribute value returning unique OrgEntity identifiers. |
java.util.List |
findOrgEntityNames(java.lang.String attrName,
java.lang.String attrValue)
Find all OrgEntities based on an attribute value returning OrgEntity names. |
boolean |
fromXML(java.lang.String xml)
Create an OrgEntity object from XML. |
java.util.List |
getAncestorOrgEntityIdentifiers()
Get a List of ancestor OrgEntityies for this OrgEntity. |
java.util.List |
getChildrenOrgEntityIdentifiers()
Get a List of child OrgEntityies for this OrgEntity. |
java.util.List |
getChildrenUserIdentifiers()
Get a List of child User records for this OrgEntity. |
java.util.List |
getDescendantOrgEntityIdentifiers()
Get a List of descendant OrgEntityies for this OrgEntity. |
java.util.List |
getDescendantUserIdentifiers()
Get a List of descendant Users for this OrgEntity. |
com.ibm.bct.rp.cms.OrgEntityVO |
getOrgEntity()
Get the OrgEntity Value Object for this OrgEntityXML object. |
com.ibm.bct.rp.cms.OrgEntityVO |
getOrgEntity(java.lang.String orgEntityId)
Retrieve from WMS the OrgEntity for the specified OrgEntity identifier. |
java.lang.String |
getParentOrgEntityIdentifier()
Get the parent OrgEntity for this OrgEntity. |
java.util.Map |
getServiceAttributes()
Return a Map of all service related attributes for this OrgEntity object. |
java.util.Map |
getServiceAttributes(java.lang.String servPrefix)
Return a Map of all related attributes that start with the specified prefix for this OrgEntity object. |
java.util.List |
searchOrgEntities(java.lang.String attrName,
java.lang.String attrValue,
java.util.List getAttr)
Find all OrgEntities based on an attribute value and return a list of attribute Maps. |
java.lang.String |
toAttribXML(java.lang.String topLevel,
java.util.List attrList)
Convert this OrgEntity object to XML with values output as attributes. |
java.lang.String |
toXML()
Convert OrgEntity to XML. |
java.lang.String |
updateOrgEntity()
Create or update if it already exists on an OrgEntity in WMS based on attributes in this OrgEntity object. |
Constructor Detail |
public OrgEntityXML()
public OrgEntityXML(java.lang.String theXML)
java.lang.String
- theXML - The XML document with the OrgEntity definition.public OrgEntityXML(com.ibm.bct.rp.cms.OrgEntityVO orgVO)
com.ibm.websphere.memberservice.objects.OrgEntityVO
- orgVO - The OrgEntity value object.public OrgEntityXML(java.lang.String theIiopNode, java.lang.String orgEntityId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
java.lang.String
- theIiopNode - The IIOP node of the CMS to access (null=use "localhost").java.lang.String
- orgEntityId - The OrgEntity Id for the CMS retrieve.public OrgEntityXML(java.lang.String theIiopNode, java.lang.String interchangeType, java.lang.String interchangeId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
java.lang.String
- theIiopNode - The IIOP node of the CMS to access (null=use "localhost").java.lang.String
- interchangeType - The integchange type.java.lang.String
- interchangeId - The integchange ID.Method Detail |
public java.util.List getAncestorOrgEntityIdentifiers()
public java.util.List getChildrenOrgEntityIdentifiers()
public java.util.List getChildrenUserIdentifiers()
public java.util.List getDescendantOrgEntityIdentifiers()
public java.util.List getDescendantUserIdentifiers()
public java.lang.String getParentOrgEntityIdentifier()
public com.ibm.bct.rp.cms.OrgEntityVO getOrgEntity()
public com.ibm.bct.rp.cms.OrgEntityVO getOrgEntity(java.lang.String orgEntityId) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String orgEntityId - The OrgEntity identifier.public java.lang.String createOrgEntity() throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
public java.lang.String updateOrgEntity() throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
public void deleteOrgEntity(boolean includeDescendants) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
boolean
- includeDescendants - also delete descendants (flag ignored in this version)public java.util.List findOrgEntities(java.lang.String attrName, java.lang.String attrValue) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.public java.util.List findOrgEntityNames(java.lang.String attrName, java.lang.String attrValue) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.public java.util.List searchOrgEntities(java.lang.String attrName, java.lang.String attrValue, java.util.List getAttr) throws com.ibm.bct.rp.cms.MemberServiceException, java.rmi.RemoteException, com.ibm.bct.rp.cms.CreateException, com.ibm.bct.rp.cms.NamingException
input
- java.lang.String attrName - The name of the attribute to search on.input
- java.lang.String attrValue - The value to search for.input
- java.util.List getAttr - A list of attribute names of the values to return.public java.lang.String toAttribXML(java.lang.String topLevel, java.util.List attrList)
input
- java.lang.String topLevel - Top level tag.input
- java.util.List attrib - List of Attribute names to output.public java.lang.String toXML()
public boolean fromXML(java.lang.String xml)
input
- java.lang.String xml - XML string representing the OrgEntity.public java.util.Map getServiceAttributes()
public java.util.Map getServiceAttributes(java.lang.String servPrefix)
input
- java.lang.String servPrefix - Prefix for the attributes to be returned.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |