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 |