com.filenet.wcm.toolkit.server.util.xml

Class WcmXMLSubscription

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
  3. extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
  4. extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
  5. extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLSubscription
  1. public class WcmXMLSubscription
  2. extends WcmXMLProperties
WcmXMLProperties derived class for manipulating the Workflow Subscription specific XML

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
 ELEM_EVENTACTION
XPath for event action node
  1. static
  2. java.lang.String
 ELEM_SOURCE
XPath for source node
  1. static
  2. java.lang.String
 ELEM_TARGET
XPath for target node
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
ELEM_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

Method Summary

Modifier and Type Method and Description
  1. org.w3c.dom.Element
 createWorkflowsubscriptionElement()
Create the workflowsubscription Element
  1. protected
  2. org.w3c.dom.Element
 getEventActionElement()
Returns the Element for the eventaction
  1. java.lang.String
 getEventActionId()
Returns the eventaction id
  1. protected
  2. org.w3c.dom.Element
 getSourceElement()
Returns the source Element
  1. java.lang.String
 getSourceId()
Returns the id of the source
  1. java.lang.String
 getSourceLabel()
Returns the Label of the source
  1. java.lang.String
 getSourceVernum()
returns the version number
  1. java.lang.String
 getSubscriptionId()
  1. java.lang.String
 getSubscriptionLabel()
  1. java.lang.String
 getTargetClass()
Returns the target class
  1. protected
  2. org.w3c.dom.Element
 getTargetElement()
Get the target Element
  1. java.lang.String
 getTargetId()
Returns the target Id
  1. int
 getTargetType()
Returns the target type
  1. protected
  2. org.w3c.dom.Element
 getWorkflowsubscription()
Returns the workflowsubscription Element or creates a new one
  1. static
  2. WcmXMLSubscription
 getXMLSubscription()
get method returns a new instance of this object
  1. static
  2. WcmXMLSubscription
 getXMLSubscription(org.w3c.dom.Document newXMLSubscription)
get method creates or contains the Document as one of this type
  1. static
  2. org.w3c.dom.Document
 getXMLSubscriptions(WcmSearchDataProvider sdp,java.lang.String XSLFile,java.lang.String objectStore)
Deprecated. use getXMLSubscriptionsRelative
  1. static
  2. org.w3c.dom.Document
 getXMLSubscriptionsRelative(WcmSearchDataProvider sdp,java.lang.String XSLFile,java.lang.String objectStore)
Get Subscription XML using ADO query on the indicated object store.
  1. boolean
 isSourceModified()
Indicates if the source has been modified
  1. org.w3c.dom.Element
 setDocumentTarget(java.lang.String sName,java.lang.String sVerSerId,java.lang.String sId,java.lang.String sVernum)
Handle setting document targets
  1. void
 setEventActionId(java.lang.String sId)
Set the eventaction id
  1. org.w3c.dom.Element
 setObjectStoreId(java.lang.String sObjectStoreName)
Clear properties that may be unapplicable on a target change, then call base class method
  1. void
 setSourceId(java.lang.String sId)
Sets the source Id
  1. void
 setSourceLabel(java.lang.String sLabel)
Sets the source Label
  1. org.w3c.dom.Element
 setTarget(int nType,java.lang.String sName,java.lang.String sId)
Handles setting the target for all but document target types
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
addMultiObjectValues, addMultiValues, addMultiValues, createComponentRelationshipElement, createCustomObjectElement, createDocumentElement, createFolderElement, createLinkElement, createPropertiesElement, createPropertyElement, createPropertyElement, createPropertyElement, createPropertyElement, getComponentRelationship, getCustomObject, getDocument, getFolder, getLink, getPropertiesElement, getPropertyByID, getPropertyByID, getPropertyByName, getPropertyByName, getPropertySymnameById, getPropertyValueByID, getPropertyValueByName, getPropertyValueByName, getPropertyValueIdByName, getXMLProperties, getXMLProperties, removeAllPropValues, removeObjectValuesByName, removeProperties, removePropertyByName, removePropValues, removeValuesByName, removeValuesByName, setObjectElement, setObjectElement, setPropertyByID, setPropertyByName, setPropertyByName, setPropertyElement
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
getClassdescElement, getClassId, getClassName, getObjectElement, getObjectId, getObjectStoreElement, getObjectStoreId, getObjectTagValue, getObjectXPath, getXMLObject, getXMLObject, setClassDescription, 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

ELEM_TARGET

  1. public static final java.lang.String ELEM_TARGET
XPath for target node
See Also:
Constant Field Values

ELEM_SOURCE

  1. public static final java.lang.String ELEM_SOURCE
XPath for source node
See Also:
Constant Field Values

ELEM_EVENTACTION

  1. public static final java.lang.String ELEM_EVENTACTION
XPath for event action node
See Also:
Constant Field Values

Method Detail

getXMLSubscription

  1. public static WcmXMLSubscription getXMLSubscription( )
  2. throws java.lang.Exception
get method returns a new instance of this object
Returns:
WcmXMLSubscription The new WcmXMLSubscription object
Throws:
java.lang.Exception

getXMLSubscriptions

  1. public static org.w3c.dom.Document getXMLSubscriptions( WcmSearchDataProvider sdp,
  2. java.lang.String XSLFile,
  3. java.lang.String objectStore)
  4. throws java.lang.Exception
Deprecated. use getXMLSubscriptionsRelative
Throws:
java.lang.Exception

getXMLSubscriptionsRelative

  1. public static org.w3c.dom.Document getXMLSubscriptionsRelative( WcmSearchDataProvider sdp,
  2. java.lang.String XSLFile,
  3. java.lang.String objectStore)
  4. throws java.lang.Exception
Get Subscription XML using ADO query on the indicated object store.
Parameters:
sdp - The Search data provider that will perform the search
XSLFile - The XSL file for transforming the ADO
objectStore - The object store to search
Returns:
The Subscription XML
Throws:
java.lang.Exception

setObjectStoreId

  1. public org.w3c.dom.Element setObjectStoreId( java.lang.String sObjectStoreName)
  2. throws java.lang.Exception
Clear properties that may be unapplicable on a target change, then call base class method
Overrides:
setObjectStoreId in class WcmXMLObject
Parameters:
sObjectStoreName -
Returns:
Element for the id
Throws:
java.lang.Exception

getXMLSubscription

  1. public static WcmXMLSubscription getXMLSubscription( org.w3c.dom.Document newXMLSubscription)
  2. throws java.lang.Exception
get method creates or contains the Document as one of this type
Parameters:
newXMLSubscription - The Document to contain
Returns:
WcmXMLSubscription The new WcmXMLSubscription object
Throws:
java.lang.Exception

getWorkflowsubscription

  1. protected org.w3c.dom.Element getWorkflowsubscription( )
  2. throws java.lang.Exception
Returns the workflowsubscription Element or creates a new one
Returns:
The workflowsubscription Element
Throws:
java.lang.Exception

createWorkflowsubscriptionElement

  1. public org.w3c.dom.Element createWorkflowsubscriptionElement( )
  2. throws java.lang.Exception
Create the workflowsubscription Element
Returns:
The new workflowsubscription Element
Throws:
java.lang.Exception

getTargetElement

  1. protected org.w3c.dom.Element getTargetElement( )
  2. throws java.lang.Exception
Get the target Element
Returns:
The target Element
Throws:
java.lang.Exception

getEventActionElement

  1. protected org.w3c.dom.Element getEventActionElement( )
  2. throws java.lang.Exception
Returns the Element for the eventaction
Returns:
The Element for the eventaction
Throws:
java.lang.Exception

getEventActionId

  1. public java.lang.String getEventActionId( )
  2. throws java.lang.Exception
Returns the eventaction id
Returns:
The eventaction id
Throws:
java.lang.Exception

setEventActionId

  1. public void setEventActionId(java.lang.String sId)
  2. throws java.lang.Exception
Set the eventaction id
Parameters:
sId - for the eventaction
Throws:
java.lang.Exception

getSourceElement

  1. protected org.w3c.dom.Element getSourceElement( )
  2. throws java.lang.Exception
Returns the source Element
Returns:
The source Element
Throws:
java.lang.Exception

getSourceId

  1. public java.lang.String getSourceId( )
  2. throws java.lang.Exception
Returns the id of the source
Returns:
The Source Id
Throws:
java.lang.Exception

getSourceLabel

  1. public java.lang.String getSourceLabel( )
  2. throws java.lang.Exception
Returns the Label of the source
Returns:
The Source Label
Throws:
java.lang.Exception

getSubscriptionId

  1. public java.lang.String getSubscriptionId( )
  2. throws java.lang.Exception
Throws:
java.lang.Exception

getSubscriptionLabel

  1. public java.lang.String getSubscriptionLabel( )
  2. throws java.lang.Exception
Throws:
java.lang.Exception

isSourceModified

  1. public boolean isSourceModified( )
  2. throws java.lang.Exception
Indicates if the source has been modified
Returns:
true of false indicating if the source has been modified
Throws:
java.lang.Exception

getSourceVernum

  1. public java.lang.String getSourceVernum( )
  2. throws java.lang.Exception
returns the version number
Returns:
The version number: major.minor
Throws:
java.lang.Exception

setSourceId

  1. public void setSourceId(java.lang.String sId)
  2. throws java.lang.Exception
Sets the source Id
Parameters:
sId - Value to use
Throws:
java.lang.Exception

setSourceLabel

  1. public void setSourceLabel(java.lang.String sLabel)
  2. throws java.lang.Exception
Sets the source Label
Parameters:
sLabel - Value to use
Throws:
java.lang.Exception

setDocumentTarget

  1. public org.w3c.dom.Element setDocumentTarget( java.lang.String sName,
  2. java.lang.String sVerSerId,
  3. java.lang.String sId,
  4. java.lang.String sVernum)
  5. throws java.lang.Exception
Handle setting document targets
Parameters:
sName - The name of the document target
sVerSerId - The version series id for the document target
sId - The id for the document target
sVernum - The version number for the document target
Returns:
Element The document target
Throws:
java.lang.Exception

getTargetId

  1. public java.lang.String getTargetId( )
  2. throws java.lang.Exception
Returns the target Id
Returns:
id The target Id
Throws:
java.lang.Exception

getTargetClass

  1. public java.lang.String getTargetClass( )
  2. throws java.lang.Exception
Returns the target class
Returns:
String The target class name.
Throws:
java.lang.Exception

getTargetType

  1. public int getTargetType()
  2. throws java.lang.Exception
Returns the target type
Returns:
The target type
Throws:
java.lang.Exception

setTarget

  1. public org.w3c.dom.Element setTarget( int nType,
  2. java.lang.String sName,
  3. java.lang.String sId)
  4. throws java.lang.Exception
Handles setting the target for all but document target types
Parameters:
nType - The Object Type
sName - The target name
sId - The target Id
Returns:
target Element
Throws:
java.lang.Exception