uPortal 2.4.1
API Documentation

org.jasig.portal.groups
Class LockableEntityGroupImpl

java.lang.Object
  extended byorg.jasig.portal.groups.GroupMemberImpl
      extended byorg.jasig.portal.groups.EntityGroupImpl
          extended byorg.jasig.portal.groups.LockableEntityGroupImpl
All Implemented Interfaces:
IBasicEntity, IEntityGroup, IGroupMember, ILockableEntityGroup

public class LockableEntityGroupImpl
extends EntityGroupImpl
implements ILockableEntityGroup

Extends EntityGroupImpl to make it lockable for writing.

Version:
$Revision: 1.6 $
Author:
Dan Ellentuck

Constructor Summary
LockableEntityGroupImpl(java.lang.String groupKey, java.lang.Class groupType)
          LockableEntityGroupImpl constructor.
 
Method Summary
 void delete()
          Delegates to the factory.
 IEntityLock getLock()
           
 void setLock(IEntityLock newLock)
           
 java.lang.String toString()
          Returns a String that represents the value of this object.
 void update()
          Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.
 void updateAndRenewLock()
          Updates the group and its members and renews the lock.
 void updateMembers()
          Commit this IEntityGroup's memberships to the data store.
 void updateMembersAndRenewLock()
          Updates the members and renews the lock.
 
Methods inherited from class org.jasig.portal.groups.EntityGroupImpl
addMember, contains, deepContains, equals, getAddedMembers, getAllEntities, getAllMembers, getCreatorID, getDescription, getEntities, getEntityIdentifier, getEntityKey, getEntityType, getGroupID, getLeafType, getLocalKey, getMemberGroupNamed, getMembers, getName, getRemovedMembers, getServiceName, getType, hasAdds, hasDeletes, hashCode, hasMembers, isDirty, isEditable, isGroup, primSetName, removeMember, setCreatorID, setDescription, setLocalGroupService, setName, setServiceName
 
Methods inherited from class org.jasig.portal.groups.GroupMemberImpl
addGroup, getAllContainingGroups, getContainingGroups, getKey, getUnderlyingEntityIdentifier, isDeepMemberOf, isEntity, isMemberOf, removeGroup
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.jasig.portal.groups.IEntityGroup
addMember, getCreatorID, getDescription, getLocalKey, getName, getServiceName, isEditable, removeMember, setCreatorID, setDescription, setLocalGroupService, setName
 
Methods inherited from interface org.jasig.portal.groups.IGroupMember
contains, deepContains, equals, getAllContainingGroups, getAllEntities, getAllMembers, getContainingGroups, getEntities, getEntityType, getKey, getLeafType, getMemberGroupNamed, getMembers, getType, getUnderlyingEntityIdentifier, hashCode, hasMembers, isDeepMemberOf, isEntity, isGroup, isMemberOf
 
Methods inherited from interface org.jasig.portal.IBasicEntity
getEntityIdentifier
 

Constructor Detail

LockableEntityGroupImpl

public LockableEntityGroupImpl(java.lang.String groupKey,
                               java.lang.Class groupType)
                        throws GroupsException
LockableEntityGroupImpl constructor.

Parameters:
groupKey - java.lang.String
groupType - java.lang.Class
Throws:
GroupsException
Method Detail

delete

public void delete()
            throws GroupsException
Delegates to the factory.

Specified by:
delete in interface IEntityGroup
Overrides:
delete in class EntityGroupImpl
Throws:
GroupsException

getLock

public IEntityLock getLock()
Specified by:
getLock in interface ILockableEntityGroup
Returns:
org.jasig.portal.concurrency.IEntityLock

setLock

public void setLock(IEntityLock newLock)
Specified by:
setLock in interface ILockableEntityGroup
Parameters:
newLock - org.jasig.portal.concurrency.IEntityLock

toString

public java.lang.String toString()
Description copied from class: EntityGroupImpl
Returns a String that represents the value of this object.

Overrides:
toString in class EntityGroupImpl
Returns:
a string representation of the receiver

update

public void update()
            throws GroupsException
Description copied from interface: IEntityGroup
Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.

Specified by:
update in interface IEntityGroup
Overrides:
update in class EntityGroupImpl
Throws:
GroupsException

updateAndRenewLock

public void updateAndRenewLock()
                        throws GroupsException
Description copied from interface: ILockableEntityGroup
Updates the group and its members and renews the lock.

Specified by:
updateAndRenewLock in interface ILockableEntityGroup
Throws:
GroupsException

updateMembers

public void updateMembers()
                   throws GroupsException
Description copied from interface: IEntityGroup
Commit this IEntityGroup's memberships to the data store.

Specified by:
updateMembers in interface IEntityGroup
Overrides:
updateMembers in class EntityGroupImpl
Throws:
GroupsException

updateMembersAndRenewLock

public void updateMembersAndRenewLock()
                               throws GroupsException
Description copied from interface: ILockableEntityGroup
Updates the members and renews the lock.

Specified by:
updateMembersAndRenewLock in interface ILockableEntityGroup
Throws:
GroupsException

uPortal 2.4.1
API Documentation