class: Grant

public class: Grant
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:13:28; Modified: 16.07.2009 15:23:29;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {6B0543AC-DC56-4ebb-B48B-AA3747FC8FE5}
<create>required</create>
<update>not-allowed (see note 1.)</update>
<comment>1. Update is not defined for a grant.</comment> 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://escidoc.de/core/01/properties/" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="grant"> <xs:complexType> <xs:sequence> <xs:element name="properties"> <xs:complexType> <xs:sequence> <xs:element ref="ns2:creation-date" minOccurs="0"/> <xs:element ref="ns:created-by" minOccurs="0"/> <xs:element ref="ns2:revocation-date" minOccurs="0"/> <xs:element ref="ns:revoked-by" minOccurs="0"/> <xs:element ref="ns2:grant-remark" minOccurs="0"/> <xs:element ref="ns2:revocation-remark" minOccurs="0"/> <xs:element ref="ns:role"/> <xs:element ref="ns:assigned-on" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </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://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://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: IntelligentVO

Appears in: grants

Connections
 
Custom Properties
 
Grant Attributes
Attribute Details
private String
  assignedOn
private String
  createdBy
private Date
  creationDate
private String
  grantedTo
private String
  grantRemark
private String
  grantType
private Date
  lastModificationDate
private String
  objid
private Date
  revocationDate
private String
  revocationRemark
private String
  revokedBy
private String
  role
 
Grant Methods
Operation Details
public
createInCoreservice(
   String userHandle,
   String comment):void
Sequential
Tags: throws=RuntimeException
Notes: Creates this grant in the coreservice.
public
getAssignedOn():String
Sequential
Notes: Get the 'assigned-on' element value.
<create>optional (see note 2.)</create>
<update>not-allowed (see note 1.)</update>
<comment>2. The referenced resource must be of type container, content-model, context, item, organizational unit, or scope. Granting roles on other resource types is not supported, yet.</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
getGrantedTo():String
Sequential
public
getGrantRemark():String
Sequential
Notes: Get the 'grant-remark' element value.
<create>optional</create>
<update>not-allowed (see note 1.)</update>
@return value
public
getGrantType():String
Sequential
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
getObjid():String
Sequential
Notes: Get the 'objid' attribute value. <create>discarded</create><update>discarded</update>
@return value
public
getRevocationDate():Date
Sequential
Notes: Get the 'revocation-date' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@return value
public
getRevocationRemark():String
Sequential
Notes: Get the 'revocation-remark' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@return value
public
getRevokedBy():String
Sequential
Notes: Get the 'revoked-by' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@return value
public
getRole():String
Sequential
Notes: Get the 'role' element value.
<create>required</create>
<update>not-allowed (see note 1.)</update>
@return value
public
Grant(
   String userHandle,
   String userId,
   String grantId,
   UserType userType):
Sequential
Tags: throws=RuntimeException
Notes: Retrieves a grant from the coreservice.
public
Grant():
Sequential
public
Grant(
   Grant toBeCloned):
Sequential
Notes: Clone constructor
public
isDepositor(
   ReferenceObject objRef):boolean
Sequential
Notes: Delivers true if the granted role is of type 'depositor' for the given object (normally a PubCollection).
public
isModerator(
   ReferenceObject objRef):boolean
Sequential
Notes: Delivers true if the granted role is of type 'moderator' for the given object (normally a PubCollection).
public
revokeInCoreservice(
   String userHandle,
   String comment):void
Sequential
Tags: throws=RuntimeException
Notes: Revokes this grant in the coreservice.
public
setAssignedOn(
   String assignedOn):void
Sequential
Notes: Set the 'assigned-on' element value.
<create>optional (see note 2.)</create>
<update>not-allowed (see note 1.)</update>
<comment>2. The referenced resource must be of type container, content-model, context, item, organizational unit, or scope. Granting roles on other resource types is not supported, yet.</comment>
@param AssignedOn
public
setCreatedBy(
   String createdBy):void
Sequential
Notes: Set the 'created-by' element value.
<create>discarded</create>
<update>discarded</update>
@param CreatedBy
public
setCreationDate(
   Date creationDate):void
Sequential
Notes: Set the 'creation-date' element value.
<create>discarded</create>
<update>discarded</update>
@param CreationDate
public
setGrantedTo(
   String grantedTo):void
Sequential
public
setGrantRemark(
   String grantRemark):void
Sequential
Notes: Set the 'grant-remark' element value.
<create>optional</create>
<update>not-allowed (see note 1.)</update>
@param GrantRemark
public
setGrantType(
   String grantType):void
Sequential
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
setObjid(
   String objid):void
Sequential
Notes: Set the 'objid' attribute value. <create>discarded</create><update>discarded</update>
public
setRevocationDate(
   Date revocationDate):void
Sequential
Notes: Set the 'revocation-date' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@param RevocationDate
public
setRevocationRemark(
   String revocationRemark):void
Sequential
Notes: Set the 'revocation-remark' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@param RevocationRemark
public
setRevokedBy(
   String revokedBy):void
Sequential
Notes: Set the 'revoked-by' element value.
<create>discarded</create>
<update>not-allowed (see note 1.)</update>
@param RevokedBy
public
setRole(
   String role):void
Sequential
Notes: Set the 'role' element value.
<create>required</create>
<update>not-allowed (see note 1.)</update>
@param Role