|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWTableDefinition
filenet.vw.api.VWRosterDefinition
public final class VWRosterDefinition
Use the VWRosterDefinition.java class to retrieve and administer roster definition information. The methods of this class operate in conjunction with VWSystemConfiguration class methods as follows:
VWSystemConfiguration.createRosterDefinition(String)
returns a default roster definition.
VWSystemConfiguration.updateRosterDefinition(VWRosterDefinition)
uses this VWRosterDefinition object to update a roster definition.
VWSystemConfiguration.getRosterDefinitions()
returns
an array of the roster definitions associated with this system
configuration.
VWSystemConfiguration.commit()
saves roster definition changes
to the server.
This class contains the following access control methods that input VWParticipant objects:
setCreateSecurityPx(VWParticipant[])
setReadSecurityPx(VWParticipant[])
setWriteSecurityPx(VWParticipant[])
getCreateSecurityPx()
getReadSecurityPx()
getWriteSecurityPx()
getReadSecurity()
getWriteSecurity()
getCreateSecurity()
VWParticipant
,
VWSystemConfiguration
,
Serialized FormField Summary |
---|
Fields inherited from class filenet.vw.api.VWTableDefinition |
---|
CONFIG_TYPE_LOG, CONFIG_TYPE_QUEUE, CONFIG_TYPE_ROSTER, LVALUE, RVALUE |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.Object |
clone()
Creates a clone of this VWRosterDefinition object. |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field on the roster, based on the supplied field name and type. |
void |
createFieldDefinitions(VWExposedFieldDefinition[] theDefs)
Creates the complete field definition for this roster. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for the roster. |
void |
createIndexDefinitions(VWIndexDefinition[] theDefs)
Creates the complete index definition for this roster. |
void |
deleteFieldDefinition(java.lang.String theName)
Deletes an exposed field from the roster. |
void |
deleteIndexDefinition(java.lang.String theName)
Deletes an index from this roster. |
java.lang.String[] |
getCreateSecurity()
Returns a list of users and/or groups who have create access to the roster. |
VWParticipant[] |
getCreateSecurityPx()
Returns an array of VWParticipant objects that names the users and/or groups who have create access to the roster. |
java.lang.String |
getDescription()
Returns the description for this roster. |
VWExposedFieldDefinition |
getField(java.lang.String name)
Returns the field definition for the specified exposed field in this roster. |
VWIndexDefinition |
getIndex(java.lang.String name)
Get an index definition specified for this roster definition. |
java.lang.String |
getName()
Gets the name of this roster. |
java.lang.String[] |
getReadSecurity()
Lists the users and/or groups who currently have read access to the roster. |
VWParticipant[] |
getReadSecurityPx()
Returns an array VWParticipant objects that specifies the users and/or groups who currently have read access to the roster. |
int |
getServerId()
Gets the home server ID of this roster definition. |
java.lang.String[] |
getWriteSecurity()
Lists users and/or groups who have write access to the roster. |
VWParticipant[] |
getWriteSecurityPx()
Returns an array of VWParticipant objects containing the names of the user and/or groups who have write access to this roster. |
static VWExposedFieldDefinition[] |
optionalSystemFields()
Returns workflow system exposed fields that are marked as optional. |
void |
setCreateSecurity(java.lang.String[] theNames)
Sets create access to the roster for the passed-in list of users and/or groups. |
void |
setCreateSecurityPx(VWParticipant[] thePxList)
Sets create access on the roster for the users and/or groups specified by the passed-in array of VWParticipant objects. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this roster definition. |
void |
setReadSecurity(java.lang.String[] theNames)
Sets read access on the roster for the passed-in list of users and/or groups. |
void |
setReadSecurityPx(VWParticipant[] thePxList)
Sets read access privilege on this roster for the users and/or groups represented by the passed-in array of VWParticipant objects. |
void |
setServerId(int theNewServerId)
Sets the home server ID of the roster. |
void |
setWriteSecurity(java.lang.String[] theNames)
Sets write access to this roster for the users and/or groups specified by an input list. |
void |
setWriteSecurityPx(VWParticipant[] thePxList)
Sets write access to the current roster for the users and / or groups specified by the passed-in array of VWParticipant objects. |
java.lang.String |
toString()
Returns the string version of the roster definition. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class filenet.vw.api.VWTableDefinition |
---|
getFields, getIndexes, getLocalizedString, hasFieldName, isValid, optionalSystemFields |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface filenet.vw.api.IVWTableDefinition |
---|
getFields, getIndexes |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength) throws VWException
createFieldDefinition
in interface IVWTableDefinition
createFieldDefinition
in class VWTableDefinition
theName
- The name of the field to
expose.
theType
- An integer value indicating the data type
associated with the exposed field. Note that arrays, for any
of the data types, are not allowed. Valid values are as follows:
theLength
- An integer value specifying the length
(number of bytes) of data stored if the data field is a string. If
the field type is other than string, specify the 0 (zero).
VWException
public void deleteFieldDefinition(java.lang.String theName) throws VWException
deleteFieldDefinition
in interface IVWTableDefinition
deleteFieldDefinition
in class VWTableDefinition
theName
- The name of the exposed
field to delete from the roster.
VWException
- Thrown if the
field specified in the theName parameter is not found.public void createFieldDefinitions(VWExposedFieldDefinition[] theDefs) throws VWException
theDefs
- the array of VWExposedFieldDefinition
VWException
public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
createIndexDefinition
in interface IVWTableDefinition
createIndexDefinition
in class VWTableDefinition
theName
- The name of the new index
field.theFieldNames
- A string array containing the system
fields and/or user-defined exposed fields.
VWException
- Thrown if the system finds an error
in the name or if the fields are undefined.public void deleteIndexDefinition(java.lang.String theName) throws VWException
deleteIndexDefinition
in interface IVWTableDefinition
deleteIndexDefinition
in class VWTableDefinition
theName
- The name of the index to be
deleted from the roster.
VWException
- Thrown if the
system does not find the index name.public void createIndexDefinitions(VWIndexDefinition[] theDefs) throws VWException
theDefs
- the array of VWIndexDefinition
VWException
public VWExposedFieldDefinition getField(java.lang.String name) throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
name
- A String containing the field name.
VWException
public VWIndexDefinition getIndex(java.lang.String name) throws VWException
name
- A String containing the index name.
VWException
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getName
in interface IVWTableDefinition
getName
in class VWTableDefinition
public int getServerId()
getServerId
in class VWTableDefinition
public void setServerId(int theNewServerId) throws VWException
setServerId
in class VWTableDefinition
theNewServerId
- An integer value to be used as the new
home server ID.
VWException
- Thrown if the method cannot
set the home server ID of the roster.VWSystemConfiguration.getServerIDs()
public java.lang.String[] getReadSecurity()
Note: Use this method in conjunction with setWriteSecurity(String[]); do not use this method with setWriteSecurityPx(VWParticipant[]). For more information see Managing User Lists and Different Types of Security.
getReadSecurity
in class VWTableDefinition
public VWParticipant[] getReadSecurityPx() throws VWException
Note: Use this method in conjunction with setWriteSecurityPx(VWParticipant[]); do not use this method with setWriteSecurity(String[]). For more information see Managing User Lists and Different Types of Security.
getReadSecurityPx
in class VWTableDefinition
VWException
public void setReadSecurity(java.lang.String[] theNames) throws VWException
Notes: This method does not validate user and group
information, but user and group information can be validated
subsequently by the VWSystemConfiguration.commit()
method.
Use this method in conjunction with setWriteSecurity(String[]); do not use this method with setWriteSecurityPx(VWParticipant[]). For more information see Managing User Lists and Different Types of Security.
theNames
- A list of names and/or groups who are
specified to have read access to the roster.
VWException
public void setReadSecurityPx(VWParticipant[] thePxList) throws VWException
Notes: This method does not validate user and group
information, but user and group information can be validated
subsequently by the VWSystemConfiguration.commit()
method.
Use this method in conjunction with setWriteSecurityPx(VWParticipant[]); do not use this method with setWriteSecurity(String[]). For more information see Managing User Lists and Different Types of Security.
theNames
- An array of VWParticipant containing names of
users and/or
groups, specified here to receive read access on the roster.
VWException
public java.lang.String[] getWriteSecurity()
Note: Use this method in conjunction with setWriteSecurity(String[]); do not use this method with setWriteSecurityPx(VWParticipant[]). For more information see Managing User Lists and Different Types of Security.
getWriteSecurity
in class VWTableDefinition
public VWParticipant[] getWriteSecurityPx() throws VWException
Note: Use this method in conjunction with setWriteSecurityPx(VWParticipant[]); do not use this method with setWriteSecurity(String[]). For more information see Managing User Lists and Different Types of Security.
getWriteSecurityPx
in class VWTableDefinition
VWException
public void setWriteSecurity(java.lang.String[] theNames) throws VWException
Notes: This method does not validate user and group
information, but user and group information can be validated
subsequently by the VWSystemConfiguration.commit()
method.
Use this method in conjunction with getWriteSecurity(); do not use this method with getWriteSecurityPx(). For more information see Managing User Lists and Different Types of Security.
theNames
- A list of names and/or groups, specified
here to receive write access.
VWException
public void setWriteSecurityPx(VWParticipant[] thePxList) throws VWException
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getWriteSecurityPx(); do not use this method with getCreateSecurity(). For more information see Managing User Lists and Different Types of Security.
thePxList
- An array of VWParticipant objects containing
a list of names, specified here to receive write access.
VWException
public java.lang.String[] getCreateSecurity()
Note: Use this method in conjunction with setCreateSecurity(String[]); do not use this method with setCreateSecurityPx(VWParticipant[]). For more information see Managing User Lists and Different Types of Security.
public VWParticipant[] getCreateSecurityPx() throws VWException
Note: Use this method in conjunction with setCreateSecurityPx(VWParticipant[]); do not use this method with setCreateSecurity(String[]). For more information see Managing User Lists and Different Types of Security.
VWException
- Thrown for various causes, including when
createSecurity() was used to set a different version of security
control.setCreateSecurityPx(VWParticipant[])
public void setCreateSecurity(java.lang.String[] theNames) throws VWException
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getCreateSecurity(); do not use this method with getCreateSecurityPx(). For more information see Managing User Lists and Different Types of Security.
theNames
- A list of user names and/or groups who will be
granted create access for the roster.
VWException
public void setCreateSecurityPx(VWParticipant[] thePxList) throws VWException
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getCreateSecurityPx(); do not use this method with getCreateSecurity(). For more information see Managing User Lists and Different Types of Security.
thePxList
- An Array of VWParticipant objects specifying
users and/or groups who will have create access to the roster.
VWException
public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getDescription
in interface IVWTableDefinition
getDescription
in class VWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
setDescription
in class VWTableDefinition
theDescription
- The description for
this roster definitionpublic java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class VWTableDefinition
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public static VWExposedFieldDefinition[] optionalSystemFields() throws VWException
VWException
public java.lang.Object clone()
VWRosterDefinition
object.
clone
in class VWTableDefinition
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |