|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
WcmXMLObject derived class for manipulating the Properties specific XML
Field Summary | |
static java.lang.String |
ELEM_PROPERTY
XPath for a property |
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject |
ELEM_CLASSID, ELEM_CLASSNAME, ELEM_OBJECT, ELEM_OBJECTSTORE |
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl |
ELEM_OBJECTSET, thisDoc |
Constructor Summary | |
WcmXMLProperties(org.w3c.dom.Document newXMLProperties)
Constructor takes the Document object to implement |
Method Summary | |
void |
addMultiObjectValues(java.lang.String symName,
int objectType,
java.lang.String[] values,
java.lang.String[] nameValues)
Add Multiple Object Values to a Property sValues and sNameValues arrays must be in the same order and the same size. |
void |
addMultiValues(java.lang.String id,
java.lang.String symName,
java.lang.String propType,
java.lang.String[] values,
boolean reqUniElem)
Deprecated. use same method with additional locale parameter instad - Workplace need this to construct correct message otherwise you have to use another method that catch this method throws exception and extract its message use toString(locale). |
void |
addMultiValues(java.lang.String id,
java.lang.String symName,
java.lang.String propType,
java.lang.String[] values,
boolean reqUniElem,
java.util.Locale locale)
Add multiple values to the indicated multi value property |
org.w3c.dom.Element |
createComponentRelationshipElement()
Create the Component Relationship Element |
org.w3c.dom.Element |
createCustomObjectElement()
Create the customobject Element |
org.w3c.dom.Element |
createDocumentElement()
Create the document Element |
org.w3c.dom.Element |
createFolderElement()
Create the folder Element |
org.w3c.dom.Element |
createLinkElement()
Create the Link Element |
org.w3c.dom.Element |
createPropertiesElement(org.w3c.dom.Element objectElement)
Create the properties Element |
org.w3c.dom.Element |
createPropertyElement(java.lang.String id,
java.lang.String value,
java.lang.String nameValue,
int objectType,
java.lang.String symName,
java.lang.String propType,
boolean isMultiVal)
Create a property Element with the given values |
org.w3c.dom.Element |
createPropertyElement(java.lang.String id,
java.lang.String value,
java.lang.String nameValue,
int objectType,
java.lang.String symName,
java.lang.String propType,
boolean isMultiVal,
boolean addModifiedState)
Create a property Element with the given values |
org.w3c.dom.Element |
createPropertyElement(java.lang.String id,
java.lang.String value,
java.lang.String symName,
java.lang.String propType,
boolean isMultiVal)
Create a property Element with the given values |
org.w3c.dom.Element |
createPropertyElement(java.lang.String id,
java.lang.String value,
java.lang.String symName,
java.lang.String propType,
boolean isMultiVal,
boolean addModifiedState)
Create a property Element with the given values |
org.w3c.dom.Element |
getComponentRelationship()
Returns the Component Relationship Element or creates a new one |
org.w3c.dom.Element |
getCustomObject()
Returns the customobject Element or creates a new one |
org.w3c.dom.Element |
getDocument()
Returns the document Element or creates a new one |
org.w3c.dom.Element |
getFolder()
Returns the folder Element or creates a new one |
org.w3c.dom.Element |
getLink()
Returns the Link Element or creates a new one |
org.w3c.dom.Element |
getPropertiesElement()
Returns the properties Element or creates it if it doesn't already exist |
org.w3c.dom.Element |
getPropertyByID(java.lang.String id)
Returns the property with the given ID |
org.w3c.dom.Element |
getPropertyByID(java.lang.String id,
java.lang.String xPath)
Returns the property or sub Element with the given ID and appended XPath |
org.w3c.dom.Element |
getPropertyByName(java.lang.String symName)
Retrieves the Property Element with the given symname |
org.w3c.dom.Element |
getPropertyByName(java.lang.String symName,
java.lang.String xPath)
Retrieves the property or sub value using the given XPath with the indicated symname |
java.lang.String |
getPropertySymnameById(java.lang.String id)
Retrieves the symname value of the object property with the given id. |
java.lang.String |
getPropertyValueByID(java.lang.String id)
Retrieves the value of the property with the given ID. |
java.lang.String |
getPropertyValueByName(java.lang.String symName)
Retrieves the value of the property with the given name. |
java.lang.String |
getPropertyValueByName(java.lang.String symName,
java.lang.String xPath)
Retrieves the value of the property with the given name using the given XPath. |
java.lang.String |
getPropertyValueIdByName(java.lang.String symName)
Retrieves the Id value of the object property with the given name. |
static WcmXMLProperties |
getXMLProperties()
get method returns a new instance of this object |
static WcmXMLProperties |
getXMLProperties(org.w3c.dom.Document newXMLProperties)
get method creates or contains the Document as one of this type |
void |
removeAllPropValues(java.lang.String symName)
Removes all of the property values from the property with the given ID. |
void |
removeObjectValuesByName(java.lang.String symName,
java.lang.String[] values)
Removes the given object values from the Document property with the given name. |
void |
removeProperties()
Remove all properties |
void |
removePropertyByName(java.lang.String symName)
Removes the property value from the property with the given symbolic name. |
void |
removePropValues(java.lang.String symName,
java.lang.String[] values)
Removes the given values from the Document property with the given id. |
void |
removeValuesByName(java.lang.String symName)
Removes all of the property values from the property with the given symbolic name. |
void |
removeValuesByName(java.lang.String symName,
java.lang.String[] values)
Removes the given values from the Document property with the given name. |
boolean |
setObjectElement(java.lang.String symName,
java.lang.String value,
java.lang.String nameValue,
int objectType)
Set an object valued property |
boolean |
setObjectElement(java.lang.String symName,
java.lang.String value,
java.lang.String objectStoreName,
java.lang.String nameValue,
int objectType)
|
void |
setPropertyByID(java.lang.String id,
java.lang.String xPath,
java.lang.String value)
Sets the Property or sub value with the given ID and XPath to the indicated value |
void |
setPropertyByName(java.lang.String symName,
java.lang.String value)
Sets the Property or sub value with the given ID and XPath to the indicated value |
void |
setPropertyByName(java.lang.String symName,
java.lang.String xPath,
java.lang.String value)
Sets the Property or sub value with the given ID and XPath to the indicated value |
boolean |
setPropertyElement(java.lang.String id,
java.lang.String symName,
java.lang.String value,
java.lang.String propType,
boolean isMultiVal,
java.util.Locale locale)
update or create a new property element with the given information |
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject |
getClassdescElement, getClassId, getClassName, getObjectElement, getObjectId, getObjectStoreElement, getObjectStoreId, getObjectTagValue, getObjectXPath, getXMLObject, getXMLObject, setClassDescription, setObjectStoreId, setObjectTagValue, setObjectXPath |
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl |
createCDATAChildElement, createChildElement, createChildElement, createNamespace, getDocumentImpl, getElement, getElement, getElementText, getNodeList, getThis |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ELEM_PROPERTY
Constructor Detail |
public WcmXMLProperties(org.w3c.dom.Document newXMLProperties)
newXMLProperties
- The new Document objectMethod Detail |
public static WcmXMLProperties getXMLProperties()
public static WcmXMLProperties getXMLProperties(org.w3c.dom.Document newXMLProperties)
newXMLProperties
- The Document to contain
public org.w3c.dom.Element getDocument() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createDocumentElement() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element getFolder() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createFolderElement() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element getCustomObject() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createCustomObjectElement() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element getLink() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createLinkElement() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element getComponentRelationship() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createComponentRelationshipElement() throws java.lang.Exception
java.lang.Exception
public void removeProperties() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element getPropertiesElement() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Element createPropertiesElement(org.w3c.dom.Element objectElement)
objectElement
- The folder or Document Element
public org.w3c.dom.Element createPropertyElement(java.lang.String id, java.lang.String value, java.lang.String symName, java.lang.String propType, boolean isMultiVal) throws java.lang.Exception
id
- The new property IDvalue
- The new property valuesymName
- The new property symbolic namepropType
- The new property property typeisMultiVal
- Indicates if the new property is multi-valued
java.lang.Exception
public org.w3c.dom.Element createPropertyElement(java.lang.String id, java.lang.String value, java.lang.String symName, java.lang.String propType, boolean isMultiVal, boolean addModifiedState) throws java.lang.Exception
id
- The new property IDvalue
- The new property valuesymName
- The new property symbolic namepropType
- The new property property typeisMultiVal
- Indicates if the new property is multi-valuedaddModifiedState
- boolean flag for adding the ELEM_STATE xml information to the property node
java.lang.Exception
public org.w3c.dom.Element createPropertyElement(java.lang.String id, java.lang.String value, java.lang.String nameValue, int objectType, java.lang.String symName, java.lang.String propType, boolean isMultiVal) throws java.lang.Exception
id
- The new property IDvalue
- The new property valuenameValue
- The name value for an object propertyobjectType
- The objecttype for an object propertysymName
- The new property symbolic namepropType
- The new property property typeisMultiVal
- Indicates if the new property is multi-valued
java.lang.Exception
public org.w3c.dom.Element createPropertyElement(java.lang.String id, java.lang.String value, java.lang.String nameValue, int objectType, java.lang.String symName, java.lang.String propType, boolean isMultiVal, boolean addModifiedState) throws java.lang.Exception
id
- The new property IDvalue
- The new property valuenameValue
- The name value for an object propertyobjectType
- The objecttype for an object propertysymName
- The new property symbolic namepropType
- The new property property typeisMultiVal
- Indicates if the new property is multi-valuedaddModifiedState
- boolean flag for adding the ELEM_STATE xml information to the property node
java.lang.Exception
public boolean setPropertyElement(java.lang.String id, java.lang.String symName, java.lang.String value, java.lang.String propType, boolean isMultiVal, java.util.Locale locale) throws java.lang.Exception
id
- Id of the property to updatesymName
- Symbolic name of the property to updatevalue
- Value to give the propertypropType
- Property type of the propertyisMultiVal
- Is the property multi valuedlocale
- client locale, only necessary for float property types
java.lang.Exception
public boolean setObjectElement(java.lang.String symName, java.lang.String value, java.lang.String nameValue, int objectType) throws java.lang.Exception
symName
- Symbolic name of the property to updatevalue
- Value to give the propertynameValue
- Name value of the object propertyobjectType
- Type of the object
java.lang.Exception
public boolean setObjectElement(java.lang.String symName, java.lang.String value, java.lang.String objectStoreName, java.lang.String nameValue, int objectType) throws java.lang.Exception
symName
- Symbolic name of the property to updatevalue
- Value to give the propertyobjectStoreName
- Object Store of the object propertynameValue
- Name value of the object propertyobjectType
- Type of the object
java.lang.Exception
public void addMultiObjectValues(java.lang.String symName, int objectType, java.lang.String[] values, java.lang.String[] nameValues) throws java.lang.Exception
symName
- Symbolic name of Property to add objects toobjectType
- Object type of multiple objectsvalues
- IDs of objectsnameValues
- Name values of objects
java.lang.Exception
- Exception on Errorpublic void addMultiValues(java.lang.String id, java.lang.String symName, java.lang.String propType, java.lang.String[] values, boolean reqUniElem) throws java.lang.Exception
id
- ID of the multi value propertysymName
- symbolic name of the multi value propertypropType
- Property Type of propertyvalues
- String array of valuesreqUniElem
- indicates if this property requires unique elements
java.lang.Exception
public void addMultiValues(java.lang.String id, java.lang.String symName, java.lang.String propType, java.lang.String[] values, boolean reqUniElem, java.util.Locale locale) throws java.lang.Exception
id
- ID of the multi value propertysymName
- symbolic name of the multi value propertypropType
- Property Type of propertyvalues
- String array of valuesreqUniElem
- indicates if this property requires unique elements
java.lang.Exception
public void removePropValues(java.lang.String symName, java.lang.String[] values) throws java.lang.Exception
symName
- The symbolic name of the property to remove values from.values
- The array of values to remove.
java.lang.Exception
public void removeValuesByName(java.lang.String symName, java.lang.String[] values) throws java.lang.Exception
symName
- The name of the property to remove values from.values
- The array of values to remove.
java.lang.Exception
public void removeObjectValuesByName(java.lang.String symName, java.lang.String[] values) throws java.lang.Exception
symName
- The name of the property to remove values from.values
- The array of ids to remove.
java.lang.Exception
public void removeAllPropValues(java.lang.String symName) throws java.lang.Exception
symName
- The symbolic name of the property to change.
java.lang.Exception
public void removePropertyByName(java.lang.String symName) throws java.lang.Exception
symName
- The symbolic name of the property to change.
java.lang.Exception
public void removeValuesByName(java.lang.String symName) throws java.lang.Exception
symName
- The symbolic name of the property to change.
java.lang.Exception
public java.lang.String getPropertyValueByID(java.lang.String id) throws java.lang.Exception
id
- The ID of the property whose value we want to retrieve.
java.lang.Exception
public java.lang.String getPropertyValueByName(java.lang.String symName) throws java.lang.Exception
symName
- The symbolic name of the property whose value we want to retrieve.
java.lang.Exception
public java.lang.String getPropertySymnameById(java.lang.String id) throws java.lang.Exception
id
- The id of the property whose symname we want to retrieve.
java.lang.Exception
public java.lang.String getPropertyValueIdByName(java.lang.String symName) throws java.lang.Exception
symName
- The symbolic name of the property whose value we want to retrieve.
java.lang.Exception
public java.lang.String getPropertyValueByName(java.lang.String symName, java.lang.String xPath) throws java.lang.Exception
symName
- The symbolic name of the property whose value we want to retrieve.xPath
- The XPath to append to the property plus symname XPath
java.lang.Exception
public org.w3c.dom.Element getPropertyByName(java.lang.String symName, java.lang.String xPath) throws java.lang.Exception
symName
- The symname of the required propertyxPath
- The XPath to append to the property plus symname XPath
java.lang.Exception
public org.w3c.dom.Element getPropertyByName(java.lang.String symName) throws java.lang.Exception
symName
- The symname of the required property
java.lang.Exception
public void setPropertyByName(java.lang.String symName, java.lang.String value) throws java.lang.Exception
symName
- The symbolic name of the property to setvalue
- The new value to use
java.lang.Exception
public void setPropertyByName(java.lang.String symName, java.lang.String xPath, java.lang.String value) throws java.lang.Exception
symName
- The symbolic name of the property to setxPath
- extra XPath filtervalue
- The new value to use
java.lang.Exception
public void setPropertyByID(java.lang.String id, java.lang.String xPath, java.lang.String value) throws java.lang.Exception
id
- The ID of the property to setxPath
- The XPath string to append to the property plus ID XPathvalue
- The new value to use
java.lang.Exception
public org.w3c.dom.Element getPropertyByID(java.lang.String id, java.lang.String xPath) throws java.lang.Exception
id
- The ID of the required propertyxPath
- The XPath string to append to the XPath statement
java.lang.Exception
public org.w3c.dom.Element getPropertyByID(java.lang.String id) throws java.lang.Exception
id
- The ID of the property to retrieve
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |