class: UserGroup

public class: UserGroup
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:13:32; Modified: 16.07.2009 15:23:31;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {B5EE4636-E972-4fb7-A970-9183A041F6BD}
<para> Following you will find information which elements and attributes are "required", "optional", "not-allowed" or will be "discarded" in the input XML-stream when creating or updating such an object.
</para>
<para> In "create" the rule for creating a new object is defined.
</para>
<para> In "update" the rule for updating an object is defined.
</para>
<para> Possible values are: required | optional | not-allowed | discarded
</para>
<para> required: this element or attribute has to be delivered
</para>
<para> optional: this element or attribute can be delivered and will be kept
</para>
<para> not-allowed: this element or attribute is not allowed in delivery and will cause an exception
</para>
<para> discarded: this element or attribute can be delivered but will not be used
</para>
<create>required</create>
<update>required</update> Schema fragment(s) for this class:
<pre> <xs:element xmlns:ns="http://escidoc.de/core/01/structural-relations/" xmlns:ns1="http://www.escidoc.de/schemas/commontypes/0.4" xmlns:ns2="http://www.escidoc.de/schemas/usergroup/0.5" xmlns:ns3="http://escidoc.de/core/01/properties/" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="user-group"> <xs:complexType> <xs:sequence> <xs:element name="properties"> <xs:complexType> <xs:sequence> <xs:element ref="ns3:creation-date" minOccurs="0"/> <xs:element ref="ns:created-by" minOccurs="0"/> <xs:element ref="ns:modified-by" minOccurs="0"/> <xs:element ref="ns3:email" minOccurs="0"/> <xs:element ref="ns3:name"/> <xs:element ref="ns3:label"/> <xs:element ref="ns3:description" minOccurs="0"/> <xs:element ref="ns3:type" minOccurs="0"/> <xs:element ref="ns3:active" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element ref="ns2:selectors" minOccurs="0"/> <xs:element ref="ns2:resources" minOccurs="0"/> </xs:sequence> <xs:attributeGroup ref="ns1:eSciDocResourceIdentityAttributes"/> <xs:attributeGroup ref="ns1:eSciDocRootElementAttributes"/> </xs:complexType> </xs:element> <xs:attributeGroup xmlns:ns="http://escidoc.de/core/01/structural-relations/" xmlns:ns1="http://www.escidoc.de/schemas/commontypes/0.4" xmlns:ns2="http://www.escidoc.de/schemas/usergroup/0.5" xmlns:ns3="http://escidoc.de/core/01/properties/" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="eSciDocResourceIdentityAttributes"> <xs:attribute type="xs:string" name="objid"/> </xs:attributeGroup> <xs:attributeGroup xmlns:ns="http://escidoc.de/core/01/structural-relations/" xmlns:ns1="http://www.escidoc.de/schemas/commontypes/0.4" xmlns:ns2="http://www.escidoc.de/schemas/usergroup/0.5" xmlns:ns3="http://escidoc.de/core/01/properties/" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="eSciDocRootElementAttributes"> <xs:attribute type="xs:dateTime" name="last-modification-date"/> </xs:attributeGroup>
</pre>
 

Goto: Custom Properties, Fields, Methods

Extends: IntelligentVO

See also: Resources, Selectors, IntelligentVO

Appears in: usergroup

Connections
 
Custom Properties
 
UserGroup Attributes
Attribute Details
private boolean
  active
private String
  createdBy
private Date
  creationDate
private String
  description
private String
  email
private String
  label
private Date
  lastModificationDate
private String
  modifiedBy
private String
  name
private String
  objid
private Resources
  resources
private Selectors
  selectors
private String
  type
 
UserGroup Methods
Operation Details
public
activateInCoreservice(
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Activates this user group in the coreservice.
public
addNewSelectorsInCoreservice(
   Selectors selectors,
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Adds new selectors to this user group in the coreservice.
public
createInCoreservice(
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Creates this user group in the coreservice.
public
deactivateInCoreservice(
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Deactivates this user group in the coreservice.
public
deleteInCoreservice(
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Deletes this user group in the coreservice.
public
getActive():boolean
Sequential
Notes: Get the 'active' element value.
<create> discarded (see note 1.)
</create>
<update> discarded (see note 1.)
</update>
<comment> 1. A created user group is always active. It is not possible to activate or deactivate a user group using the update method. This can only be done by using the activate() and deactivate() methods.
</comment>
@return value
public
getCreatedBy():String
Sequential
Notes: Get the 'created-by' element value.
<create>discarded</create>
<update>discarded</update>
@return value
public
getCreationDate():Date
Sequential
Notes: Get the 'creation-date' element value.
<create>discarded</create>
<update>discarded</update>
@return value
public
getDescription():String
Sequential
Notes: Get the 'description' element value.
<create>optional</create>
<update>optional</update>
@return value
public
getEmail():String
Sequential
Notes: Get the 'email' element value.
<create>optional</create>
<update>optional</update>
@return value
public
getLabel():String
Sequential
Notes: Get the 'label' element value.
<create>required</create>
<update>required</update>
@return value
public
getLastModificationDate():Date
Sequential
Notes: Get the 'last-modification-date' attribute value. <create>discarded</create>
<update>required</update>
<comment>required only in root element on update</comment>
@return value
public
getModifiedBy():String
Sequential
Notes: Get the 'modified-by' element value.
<create>discarded</create>
<update>discarded</update>
@return value
public
getName():String
Sequential
Notes: Get the 'name' element value.
<create>required</create>
<update>required</update>
@return value
public
getObjid():String
Sequential
Notes: Get the 'objid' attribute value. <create>discarded</create><update>discarded</update>
@return value
public
getResources():Resources
Sequential
Notes: Get the 'resources' element value.
@return value
public
getSelectors():Selectors
Sequential
Notes: Get the 'selectors' element value.
@return value
public
getType():String
Sequential
Notes: Get the 'type' element value.
<create>optional</create>
<update>optional</update>
@return value
public
removeSelectorsInCoreservice(
   Selectors selectors,
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Removes selectors from this user group in the coreservice.
public
setActive(
   boolean active):void
Sequential
Notes: Set the 'active' element value.
<create> discarded (see note 1.)
</create>
<update> discarded (see note 1.)
</update>
<comment> 1. A created user group is always active. It is not possible to activate or deactivate a user group using the update method. This can only be done by using the activate() and deactivate() methods.
</comment>
public
setCreatedBy(
   String createdBy):void
Sequential
Notes: Set the 'created-by' element value.
<create>discarded</create>
<update>discarded</update>
public
setCreationDate(
   Date creationDate):void
Sequential
Notes: Set the 'creation-date' element value.
<create>discarded</create>
<update>discarded</update>
public
setDescription(
   String description):void
Sequential
Notes: Set the 'description' element value.
<create>optional</create>
<update>optional</update>
public
setEmail(
   String email):void
Sequential
Notes: Set the 'email' element value.
<create>optional</create>
<update>optional</update>
public
setLabel(
   String label):void
Sequential
Notes: Set the 'label' element value.
<create>required</create>
<update>required</update>
public
setLastModificationDate(
   Date lastModificationDate):void
Sequential
Notes: Set the 'last-modification-date' attribute value. <create>discarded</create>
<update>required</update>
<comment>required only in root element on update</comment>
public
setModifiedBy(
   String modifiedBy):void
Sequential
Notes: Set the 'modified-by' element value.
<create>discarded</create>
<update>discarded</update>
public
setName(
   String name):void
Sequential
Notes: Set the 'name' element value.
<create>required</create>
<update>required</update>
public
setObjid(
   String objid):void
Sequential
Notes: Set the 'objid' attribute value. <create>discarded</create><update>discarded</update>
public
setResources(
   Resources resources):void
Sequential
Notes: Set the 'resources' element value.
public
setSelectors(
   Selectors selectors):void
Sequential
Notes: Set the 'selectors' element value.
public
setType(
   String type):void
Sequential
Notes: Set the 'type' element value.
<create>optional</create>
<update>optional</update>
public
updateInCoreservice(
   String userHandle):void
Sequential
Tags: throws=RuntimeException
Notes: Updates this user group in the coreservice.
public
UserGroup(
   String escidocId,
   String userHandle):
Sequential
Tags: throws=RuntimeException
Notes: Retrieves a user group from the coreservice.
@param id the id of the user group.
public
UserGroup():
Sequential