|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--com.opencms.defaults.A_CmsContentDefinition
|
+--com.opencms.defaults.master.CmsChannelContent
This class is the master of several Modules. It carries a lot of generic data-fileds which can be used for a special Module. The module creates a set of methods to support project-integration, history and import - export.
| Field Summary | |
protected CmsObject |
m_cms
The cms-object to get access to the cms-ressources |
| Fields inherited from interface com.opencms.boot.I_CmsLogChannels |
C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING |
| Constructor Summary | |
CmsChannelContent(CmsObject cms)
Constructor to create a new contentdefinition. |
|
CmsChannelContent(CmsObject cms,
CmsResource resource)
Constructor to create a new contentdefinition. |
|
CmsChannelContent(CmsObject cms,
Integer resourceid)
Constructor to read a existing contentdefinition from the database. |
|
CmsChannelContent(CmsObject cms,
String resourceid)
Constructor to read a existing contentdefinition from the database. |
|
| Method Summary | |
void |
check()
Plauzibilization method. |
void |
chgrp(CmsObject cms,
int group)
Change group method for changing permissions of content definition |
void |
chmod(CmsObject cms,
int accessflags)
Change access flags method for changing permissions of content definition |
void |
chown(CmsObject cms,
int owner)
Change owner method for changing permissions of content definition |
int |
copy(CmsObject cms)
Copy method for copying content definition |
void |
delete(CmsObject cms)
delete method for delete instance of content definition |
int |
getAccessFlags()
Gets the accessflags of the channel |
String |
getAccessFlagsAsString()
Convenience method to get the access-Flags as String representation. |
String |
getChannelId()
gets the unique channel Id of a content definition instance |
static Vector |
getChannelList(CmsObject cms)
Returns a vector of CD objects, sorted descending by channelname. |
String |
getChannelName()
Gets the channelname |
String |
getChannelPath()
Gets the channelname |
long |
getDateCreated()
Gets the date of the creation of the channel |
long |
getDateLastModified()
Gets the date of the last modification of the channel |
static Vector |
getFieldMethods(CmsObject cms)
Gets the methods used to display the dava values in the backoffice filelist. |
static Vector |
getFieldNames(CmsObject cms)
Gets the names of the table columns displayed in the backoffice filelist. |
static Vector |
getFilterMethods(CmsObject cms)
Gets the filter methods This method is needed for the abstract backoffice class only. |
String |
getGroup()
Gets the groupname |
int |
getGroupId()
Gets the groupid |
Integer |
getGroups(CmsObject cms,
Vector names,
Vector values)
Gets all groups, that may work for a project. |
Vector |
getHistory(CmsObject cms)
history method returns the history of content definition |
int |
getId()
gets the unique Id of a content definition instance |
int |
getLastModifiedBy()
Gets the id of the user who has modified the channel |
String |
getLastModifiedByName()
Gets the name of the user who has modified the channel |
int |
getLockedInProject()
Gets the projectId where the CD belongs to. |
int |
getLockstate()
Gets the lockstate. |
int |
getOwner()
Gets the owner of this contentdefinition. |
String |
getOwnerName()
Gets the ownername of this contentdefinition. |
String |
getParentName()
Gets the name of the parent channel |
int |
getProjectId()
Gets the projectId of a CD. |
int |
getState()
Gets the state of a CD. |
String |
getTitle()
Gets the title of the channel |
String |
getUniqueId(CmsObject cms)
gets the unique Id of a content definition instance |
Object |
getVersionFromHistory(CmsObject cms,
int versionId)
History method returns the cd of the version with the given versionId |
int |
getVersionId()
Gets the version id of version the channel |
protected void |
initValues()
This method initialises all needed members with default-values. |
static boolean |
isLockable()
This content definition is lockable. |
boolean |
isReadable()
returns true if the CD is readable for the current user |
boolean |
isWriteable()
returns true if the CD is writeable for the current user |
void |
publishResource(CmsObject cms)
publish method for publish instance of content definition |
void |
restore(CmsObject cms,
int versionId)
restore method for restore instance of content definition from history |
void |
setAccessFlags(int flags)
Sets the accessflags of the channel. |
void |
setAccessFlagsAsString(String permissions)
Get the permissions of Channel |
void |
setChannelId(String id)
sets the unique channel Id of a content definition instance |
void |
setChannelName(String name)
Sets the channelname. |
void |
setGroup(int id)
Sets the group. |
void |
setLockstate(int lockstate)
Sets the lockstates |
void |
setOwner(int id)
Sets the owner of this contentdefinition. |
void |
setParentName(String name)
Sets the parentname of the channel. |
void |
setTitle(String title)
sets the title of a content definition instance |
String |
toString()
Returns a String representation of this instance. |
void |
undelete(CmsObject cms)
undelete method for undelete instance of content definition |
void |
write(CmsObject cms)
write method to write the current content of the content definition to the database. |
| Methods inherited from class com.opencms.defaults.A_CmsContentDefinition |
accessGroup, accessOther, accessOwner, applyFilter, applyFilter, check, getUrl, hasReadAccess, hasWriteAccess, isExtendedList, isTimedContent, setGroup |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
protected CmsObject m_cms
| Constructor Detail |
public CmsChannelContent(CmsObject cms)
public CmsChannelContent(CmsObject cms,
String resourceid)
throws CmsException
cms - the cms-object for access to cms-resources.resourceid - the resource id of the channel to read.
CmsException - if the data couldn't be read from the database.
public CmsChannelContent(CmsObject cms,
Integer resourceid)
throws CmsException
cms - the cms-object for access to cms-resources.
CmsException - if the data couldn't be read from the database.
public CmsChannelContent(CmsObject cms,
CmsResource resource)
| Method Detail |
protected void initValues()
public void delete(CmsObject cms)
throws Exception
delete in class A_CmsContentDefinitioncms - the CmsObject to use.
Exception
public void undelete(CmsObject cms)
throws Exception
undelete in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.
Exceptionpublic void publishResource(CmsObject cms)
publishResource in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.
public void restore(CmsObject cms,
int versionId)
restore in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.versionId - The id of the version to restore
public void chown(CmsObject cms,
int owner)
chown in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.owner - the new owner of the cd.
public void chgrp(CmsObject cms,
int group)
chgrp in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.group - the new group of the cd.
public void chmod(CmsObject cms,
int accessflags)
chmod in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.accessflags - the new access flags of the cd.public int copy(CmsObject cms)
copy in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.
public void write(CmsObject cms)
throws Exception
write in class A_CmsContentDefinitioncms - the CmsObject to use.
Exceptionpublic String getUniqueId(CmsObject cms)
getUniqueId in class A_CmsContentDefinitioncms - the CmsObject to use.
public int getId()
getId in interface I_CmsExtendedContentDefinitionpublic int getLockedInProject()
getLockedInProject in interface I_CmsExtendedContentDefinitionpublic int getState()
getState in interface I_CmsExtendedContentDefinitionpublic int getProjectId()
getProjectId in interface I_CmsExtendedContentDefinitionpublic String getChannelId()
public void setChannelId(String id)
public String getTitle()
getTitle in interface I_CmsExtendedContentDefinitionpublic void setTitle(String title)
public int getLockstate()
getLockstate in class A_CmsContentDefinitionpublic void setLockstate(int lockstate)
setLockstate in class A_CmsContentDefinitionlockstate - the lockstate for the actual entrypublic String getOwnerName()
public int getOwner()
getOwner in interface I_CmsExtendedContentDefinitiongetOwner in class A_CmsContentDefinitionpublic void setOwner(int id)
setOwner in class A_CmsContentDefinitionpublic String getGroup()
getGroup in class A_CmsContentDefinitionpublic int getGroupId()
getGroupId in interface I_CmsExtendedContentDefinitionpublic void setGroup(int id)
public String getChannelPath()
public String getChannelName()
public void setChannelName(String name)
public void setParentName(String name)
public String getParentName()
public void setAccessFlags(int flags)
setAccessFlags in class A_CmsContentDefinitionpublic int getAccessFlags()
getAccessFlags in interface I_CmsExtendedContentDefinitiongetAccessFlags in class A_CmsContentDefinitionpublic long getDateLastModified()
getDateLastModified in interface I_CmsExtendedContentDefinitionpublic long getDateCreated()
getDateCreated in interface I_CmsExtendedContentDefinitionpublic int getLastModifiedBy()
getLastModifiedBy in interface I_CmsExtendedContentDefinitionpublic String getLastModifiedByName()
getLastModifiedByName in interface I_CmsExtendedContentDefinitionpublic int getVersionId()
getVersionId in interface I_CmsExtendedContentDefinition
public Integer getGroups(CmsObject cms,
Vector names,
Vector values)
throws CmsException
The given vectors names and values will
be filled with the appropriate information to be used for building
a select box.
cms - CmsObject Object for accessing system resources.names - Vector to be filled with the appropriate values in this method.values - Vector to be filled with the appropriate values in this method.
CmsExceptionpublic Vector getHistory(CmsObject cms)
getHistory in interface I_CmsExtendedContentDefinitioncms - the CmsObject to use.
public Object getVersionFromHistory(CmsObject cms,
int versionId)
getVersionFromHistory in interface I_CmsExtendedContentDefinitioncms - The CmsObjectversionId - The version id
public boolean isReadable()
isReadable in class A_CmsContentDefinitionpublic boolean isWriteable()
isWriteable in class A_CmsContentDefinitionpublic String toString()
toString in class Objectpublic String getAccessFlagsAsString()
public void setAccessFlagsAsString(String permissions)
public static boolean isLockable()
public static Vector getFieldNames(CmsObject cms)
public static Vector getFieldMethods(CmsObject cms)
public static Vector getFilterMethods(CmsObject cms)
public static Vector getChannelList(CmsObject cms)
throws CmsException
cms - The CmsObject.
CmsException
public void check()
throws CmsPlausibilizationException
Throws - CmsPlausibilizationException containing a vector of error-codes.
CmsPlausibilizationException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||