com.arsdigita.kernel.permissions
Class ObjectPermissionCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.kernel.permissions.ObjectPermissionCollection
All Implemented Interfaces:
DataQuery

public class ObjectPermissionCollection
extends DomainQuery

Represents a collection of permissions that have been granted on a single object.

Version:
1.0
Author:
Oumi Mehrotra
See Also:
PermissionService, PermissionDescriptor, PrivilegeDescriptor, User, Group

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery
 
Constructor Summary
protected ObjectPermissionCollection(DataQuery query)
          Constructor.
 
Method Summary
 EmailAddress getGranteeEmail()
          Gets the primary email address of the grantee of the current permission record.
 BigDecimal getGranteeID()
          Gets the party ID of the grantee of the current permission record.
 String getGranteeName()
          Returns the name of the grantee of the current permission record.
 OID getGranteeOID()
          Returns the party OID of the grantee of the current permission record.
 PersonName getGranteePersonName()
          Returns a PersonName object representing the name of the grantee of the current permission record, assuming the grantee is a User.
 PrivilegeDescriptor getPrivilege()
          Gets the granted privilege.
 boolean granteeIsUser()
          Determines whether the grantee of the current permission record is a User (as opposed to a Group).
 boolean isInherited()
          Determines whether the current permission record was inherited from the permission context of the object of this permission collection.
 
Methods inherited from class com.arsdigita.domain.DomainQuery
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, next, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

ObjectPermissionCollection

protected ObjectPermissionCollection(DataQuery query)
Constructor.

See Also:
DomainCollection.DomainCollection(DataCollection)
Method Detail

getGranteeID

public BigDecimal getGranteeID()
Gets the party ID of the grantee of the current permission record.

Returns:
the party ID of the grantee of the current permission record.

getGranteeOID

public OID getGranteeOID()
Returns the party OID of the grantee of the current permission record. The returned OID's object type is a subtype of Party.BASE_DATA_OBJECT_TYPE.

Returns:
the party OID of the grantee of the current permission record.

granteeIsUser

public boolean granteeIsUser()
Determines whether the grantee of the current permission record is a User (as opposed to a Group).

Returns:
true if the grantee is a User; false if the grantee is a Group.
See Also:
User, Group

getGranteeName

public String getGranteeName()
Returns the name of the grantee of the current permission record.

Returns:
the name of the grantee of the current permission record.
See Also:
Party.getName()

getGranteePersonName

public PersonName getGranteePersonName()
Returns a PersonName object representing the name of the grantee of the current permission record, assuming the grantee is a User.

Returns:
a PersonName object representing the name of the grantee of the current permission record.
See Also:
User.getPersonName()

getGranteeEmail

public EmailAddress getGranteeEmail()
Gets the primary email address of the grantee of the current permission record.

Returns:
the primary email address of the grantee of the current permission record.
See Also:
Party.getPrimaryEmail()

getPrivilege

public PrivilegeDescriptor getPrivilege()
Gets the granted privilege.

Returns:
the granted privilege.

isInherited

public boolean isInherited()
Determines whether the current permission record was inherited from the permission context of the object of this permission collection.

Returns:
true if the current permission record was inherited from the permission context of the object of this permission collection; false otherwise.


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC