|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.objectplanet.survey.plugin.api.Folder
ATTENTION: This class is a
facade for the system business Folder. To improve performance you can force
it to keep the reference to the business object by calling keepBusinessObject()
.
Keeping references to objects may cause inconsistencies in the system, so
allways remember to call releaseBusinessObject()
as soon as you
are finished using them.
Folder encapsulates folder data, sub-folders and surveys. The root folder
has folder id -1 and can not be deleted.
Method Summary | |
java.lang.String |
getDescription()
Gets the description of the folder. |
long |
getFolderId()
Gets the id of the folder. |
java.lang.String |
getName()
Gets the name of the folder |
long |
getParentFolderId()
Gets the id of the parent folder. |
int |
getSubFolderCount()
Gets number of sub-folders in this folder. |
ListItem[] |
getSubFolders()
Gets children, all folders in this group |
int |
getSurveyCount()
Gets number of surveys in this folder. |
ListItem[] |
getSurveys()
Gets all surveys in this group |
boolean |
hasBusinessObject()
Check if this question has reference to the business Survey object. |
void |
keepBusinessObject()
Get and keep business object. |
void |
releaseBusinessObject()
Release business object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public java.lang.String getDescription() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic long getFolderId()
public java.lang.String getName() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic long getParentFolderId() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic int getSubFolderCount() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic ListItem[] getSubFolders() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic int getSurveyCount() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic ListItem[] getSurveys() throws SurveySystemException
SurveySystemException
- If an error occurs in the systempublic boolean hasBusinessObject()
public void keepBusinessObject() throws SurveySystemException
SurveySystemException
- If an error occurs in the system.public void releaseBusinessObject()
|
Copyright © ObjectPlanet Inc. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |