|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that represents a Collaboration project
object. A project is the basic container for all other
Collaboration objects. The class allows modifications
of project metadata and security.
Note: Any
modifications to the project will not be
permanently saved until store
method is called.
Method Summary | |
java.util.Date |
getCreatedDate()
Returns the project creation date. |
java.lang.String |
getDescription()
Returns the project description. |
java.lang.String |
getDetailsURL()
Returns the URL at which the project details can be viewed. |
int |
getID()
Returns the project ID. |
java.util.Date |
getLastModifiedDate()
Returns the project last modified date. |
java.lang.String |
getName()
Returns the project name. |
int |
getOwnerUserID()
Returns the user ID of the owner of this project. |
int |
getProjectFolderID()
Returns the project folder id. |
IRole |
getRole(RoleType roleType)
Returns the role in this project based on the given role type. |
java.util.Date |
getStartDate()
Returns the project start date. |
ProjectStatus |
getStatus()
Returns the current project status. |
boolean |
hasCreatedDate()
Returns true if the project created date is available, otherwise false . |
boolean |
hasLastModifiedDate()
Returns true if the project last modified date is available, otherwise false . |
boolean |
hasStartDate()
Returns true if the project start date is available, otherwise
false . |
boolean |
isActionAllowed(ProjectPermission permission)
Returns true if the given ProjectPermission is
allowed for this project. |
void |
setDescription(java.lang.String description)
Sets the project description. |
void |
setName(java.lang.String name)
Sets the project name. |
void |
setProjectFolderID(int projectFolderID)
Sets the project folder id.. |
void |
setStartDate(java.util.Date startDate)
Sets the project start date. |
void |
setStatus(ProjectStatus status)
Sets the project status. |
void |
store()
Stores a project. |
Method Detail |
public java.util.Date getCreatedDate()
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removedpublic java.lang.String getDescription()
java.lang.IllegalStateException
- if the project has already
been removedpublic java.lang.String getDetailsURL()
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removedpublic int getID()
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removedpublic java.util.Date getLastModifiedDate()
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removedpublic java.lang.String getName()
java.lang.IllegalStateException
- if the project has already been removedpublic int getOwnerUserID()
java.lang.IllegalStateException
- if the project has already
been removedpublic int getProjectFolderID()
public IRole getRole(RoleType roleType) throws CollaborationException
roleType
- the type of role; cannot be null
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removed
CollaborationException
public java.util.Date getStartDate()
java.lang.IllegalStateException
- if the project has already
been removed, or an attempt is made to get the property value prior to it being setpublic ProjectStatus getStatus()
ProjectStatus
that indicates the current project status
java.lang.IllegalStateException
- if the project has already
been removedpublic boolean hasCreatedDate()
true
if the project created date is available, otherwise false
.
true
if the project created date is available, else false
java.lang.IllegalStateException
- if the project has already
been removedpublic boolean hasLastModifiedDate()
true
if the project last modified date is available, otherwise false
.
true
if the project last modified date is available, else false
java.lang.IllegalStateException
- if the project has already
been removedpublic boolean hasStartDate()
true
if the project start date is available, otherwise
false
.
true
if the project start date is available, else
false
java.lang.IllegalStateException
- if the project has already
been removedpublic boolean isActionAllowed(ProjectPermission permission) throws CollaborationException, java.rmi.RemoteException
ProjectPermission
is
allowed for this project. This method can be used to
determine if a user can perform a given action within
the context of a project such as editing a project,
copying a project, editing project security, etc.
See the enumeration type ProjectPermission
for details about specific project permissions.
permission
- the project permission; cannot be null
true
if the user can perform
the given action, else false
java.lang.IllegalStateException
- if the project has not yet
been stored or has already been removed
CollaborationException
- if the method call resulted in an error
java.rmi.RemoteException
- if there was a communication problem during the execution of the remote method callpublic void setDescription(java.lang.String description)
description
- the description
java.lang.IllegalStateException
- if the project has already
been removedpublic void setName(java.lang.String name)
name
- the project name
java.lang.IllegalStateException
- if the project has already
been removedpublic void setProjectFolderID(int projectFolderID)
projectFolderID
- the project folder idpublic void setStartDate(java.util.Date startDate)
store
.
startDate
- the start date of the project
java.lang.IllegalStateException
- if the project has already
been removedpublic void setStatus(ProjectStatus status)
java.lang.IllegalStateException
- if the project has already
been removedpublic void store() throws CollaborationException, java.rmi.RemoteException
java.lang.IllegalStateException
- if the project has already
been removed
CollaborationException
- if the method call resulted in an error
java.rmi.RemoteException
- if there was a communication problem during the execution of the remote method call
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.