org.dspace.authorize

Class ResourcePolicy

java.lang.Object

org.dspace.authorize.ResourcePolicy

public class ResourcePolicy
extends java.lang.Object

Class representing a ResourcePolicy

Version:

$Revision$

Author:

David Stuve

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_CUSTOM
static java.lang.String	TYPE_INHERITED
static java.lang.String	TYPE_SUBMISSION
static java.lang.String	TYPE_WORKFLOW

Method Summary

Methods

Modifier and Type	Method and Description
static ResourcePolicy	create(Context context) Create a new ResourcePolicy
void	delete() Delete an ResourcePolicy
boolean	equals(java.lang.Object obj) Return true if this object equals obj, false otherwise.
static ResourcePolicy	find(Context context, int id) Get an ResourcePolicy from the database.
int	getAction()
java.lang.String	getActionText()
java.util.Date	getEndDate() Get end date for the policy
EPerson	getEPerson() get EPerson this policy relates to
int	getEPersonID()
Group	getGroup() gets Group for this policy
int	getGroupID() gets ID for Group referred to by this policy
int	getID() Get the ResourcePolicy's internal identifier
int	getResourceID() Get the ID of a resource pointed to by the policy (is null if policy doesn't apply to a single resource.)
int	getResourceType() Get the type of the objects referred to by policy
java.lang.String	getRpDescription()
java.lang.String	getRpName()
java.lang.String	getRpType()
java.util.Date	getStartDate() Get the start date of the policy
int	hashCode() Return a hash code for this object.
boolean	isDateValid() figures out if the date is valid for the policy
void	setAction(int myid) set the action this policy authorizes
void	setEndDate(java.util.Date d) Set end date for the policy
void	setEPerson(EPerson e) assign an EPerson to this policy
void	setGroup(Group g) set Group for this policy
void	setResource(DSpaceObject o) set both type and id of resource referred to by policy
void	setResourceID(int myid) If the policy refers to a single resource, this is the ID of that resource.
void	setResourceType(int mytype) Set the type of the resource referred to by the policy
void	setRpDescription(java.lang.String description)
void	setRpName(java.lang.String name)
void	setRpType(java.lang.String type)
void	setStartDate(java.util.Date d) Set the start date for the policy
void	update() Update the ResourcePolicy

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_SUBMISSION

public static java.lang.String TYPE_SUBMISSION

TYPE_WORKFLOW

public static java.lang.String TYPE_WORKFLOW

TYPE_CUSTOM

public static java.lang.String TYPE_CUSTOM

TYPE_INHERITED

public static java.lang.String TYPE_INHERITED

Method Detail

equals

public boolean equals(java.lang.Object obj)

Return true if this object equals obj, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true if ResourcePolicy objects are equal

hashCode

public int hashCode()

Return a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

int hash of object

find

public static ResourcePolicy find(Context context,
                  int id)
                           throws java.sql.SQLException

Get an ResourcePolicy from the database.

Parameters:

context - DSpace context object

id - ID of the ResourcePolicy

Returns:

the ResourcePolicy format, or null if the ID is invalid.

Throws:

java.sql.SQLException

create

public static ResourcePolicy create(Context context)
                             throws java.sql.SQLException,
                                    AuthorizeException

Create a new ResourcePolicy

Parameters:

context - DSpace context object

Throws:

java.sql.SQLException

AuthorizeException

delete

public void delete()
            throws java.sql.SQLException

Delete an ResourcePolicy

Throws:

java.sql.SQLException

getID

public int getID()

Get the ResourcePolicy's internal identifier

Returns:

the internal identifier

getResourceType

public int getResourceType()

Get the type of the objects referred to by policy

Returns:

type of object/resource

setResource

public void setResource(DSpaceObject o)

set both type and id of resource referred to by policy

setResourceType

public void setResourceType(int mytype)

Set the type of the resource referred to by the policy

Parameters:

mytype - type of the resource

getResourceID

public int getResourceID()

Get the ID of a resource pointed to by the policy (is null if policy doesn't apply to a single resource.)

Returns:

resource_id

setResourceID

public void setResourceID(int myid)

If the policy refers to a single resource, this is the ID of that resource.

Parameters:

myid - id of resource (database primary key)

getAction

public int getAction()

Returns:

get the action this policy authorizes

getActionText

public java.lang.String getActionText()

Returns:

action text or 'null' if action row empty

setAction

public void setAction(int myid)

set the action this policy authorizes

Parameters:

myid - action ID from org.dspace.core.Constants

getEPersonID

public int getEPersonID()

Returns:

eperson ID, or -1 if EPerson not set

getEPerson

public EPerson getEPerson()
                   throws java.sql.SQLException

get EPerson this policy relates to

Returns:

EPerson, or null

Throws:

java.sql.SQLException

setEPerson

public void setEPerson(EPerson e)

assign an EPerson to this policy

Parameters:

e - EPerson

getGroupID

public int getGroupID()

gets ID for Group referred to by this policy

Returns:

groupID, or -1 if no group set

getGroup

public Group getGroup()
               throws java.sql.SQLException

gets Group for this policy

Returns:

Group, or -1 if no group set

Throws:

java.sql.SQLException

setGroup

public void setGroup(Group g)

set Group for this policy

Parameters:

g - group

isDateValid

public boolean isDateValid()

figures out if the date is valid for the policy

Returns:

true if policy has begun and hasn't expired yet (or no dates are set)

getStartDate

public java.util.Date getStartDate()

Get the start date of the policy

Returns:

start date, or null if there is no start date set (probably most common case)

setStartDate

public void setStartDate(java.util.Date d)

Set the start date for the policy

Parameters:

d - date, or null for no start date

getEndDate

public java.util.Date getEndDate()

Get end date for the policy

Returns:

end date or null for no end date

setEndDate

public void setEndDate(java.util.Date d)

Set end date for the policy

Parameters:

d - end date, or null

update

public void update()
            throws java.sql.SQLException,
                   AuthorizeException

Update the ResourcePolicy

Throws:

java.sql.SQLException

AuthorizeException

getRpName

public java.lang.String getRpName()

setRpName

public void setRpName(java.lang.String name)

getRpType

public java.lang.String getRpType()

setRpType

public void setRpType(java.lang.String type)

getRpDescription

public java.lang.String getRpDescription()

setRpDescription

public void setRpDescription(java.lang.String description)