|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.db.CmsPublishList
A container for all new/changed/deteled Cms resources that are published together.
Only classes inside the org.opencms.db package can add or remove elements to or from this list. This allows the OpenCms API to pass the list around between classes, but with restricted access to create this list.
To create a publish list, one of the public constructors must be used in order to set the basic operation mode
(project publish or direct publish).
After this, use
to fill the actual values of the publish list.CmsDriverManager.fillPublishList(CmsDbContext, CmsPublishList)
CmsDriverManager.fillPublishList(CmsDbContext, CmsPublishList)
Constructor Summary | |
CmsPublishList(CmsProject project)
Constructs a publish list for a given project. |
|
CmsPublishList(CmsResource directPublishResource,
boolean publishSiblings)
Constructs a publish list for a single direct publish resource. |
|
CmsPublishList(java.util.List directPublishResources,
boolean publishSiblings)
Constructs a publish list for a list of direct publish resources. |
|
CmsPublishList(java.util.List directPublishResources,
boolean publishSiblings,
boolean publishSubResources)
Constructs a publish list for a list of direct publish resources. |
Method Summary | |
protected void |
addFile(CmsResource resource)
Adds a new/changed/deleted Cms file resource to the publish list. |
protected void |
addFiles(java.util.List list)
Appends all of the new/changed/deleted Cms file resources in the specified list to the end of this publish list. |
protected void |
addFolder(CmsResource resource)
Adds a new/changed Cms folder resource to the publish list. |
protected void |
addFolders(java.util.List list)
Appends all of the new/changed Cms folder resources in the specified list to the end of this publish list. |
protected void |
finalize()
|
java.util.List |
getDeletedFolderList()
Returns a list of folder resources with the given state. |
java.util.List |
getDirectPublishResources()
Returns the list of resources that should be published for a "direct" publish operation. |
java.util.List |
getFileList()
Returns an unmodifiable list of the Cms file resources in this publish list. |
java.util.List |
getFolderList()
Returns an unmodifiable list of the new/changed Cms folder resources in this publish list. |
protected java.util.List |
getFolderListInstance()
Returns the list with the new/changed Cms folder resources. |
int |
getProjectId()
Returns the id of the project that should be published, or -1 if this publish list
is initialized for a "direct publish" operation. |
CmsUUID |
getPublishHistoryId()
Returns the publish history Id for this publish list. |
protected void |
initialize()
Initializes the publish list, ensuring all internal lists are in the right order. |
boolean |
isDirectPublish()
Checks if this is a publish list is used for a "direct publish" operation. |
boolean |
isPublishSiblings()
Returns true if all siblings of the project resources are to be published. |
boolean |
isPublishSubResources()
Returns true if sub-resources in folders should be published (for direct publish only). |
protected boolean |
remove(CmsResource resource)
Removes a Cms resource from the publish list. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsPublishList(CmsProject project)
project
- the project to publish, this should always be the id of the current projectpublic CmsPublishList(CmsResource directPublishResource, boolean publishSiblings)
directPublishResource
- a VFS resource to be published directlypublishSiblings
- indicates if all siblings of the selected resources should be publishedpublic CmsPublishList(java.util.List directPublishResources, boolean publishSiblings)
directPublishResources
- a list of CmsResource
instances to be published directlypublishSiblings
- indicates if all siblings of the selected resources should be publishedpublic CmsPublishList(java.util.List directPublishResources, boolean publishSiblings, boolean publishSubResources)
directPublishResources
- a list of CmsResource
instances to be published directlypublishSiblings
- indicates if all siblings of the selected resources should be publishedpublishSubResources
- indicates if sub-resources in folders should be published (for direct publish only)Method Detail |
public java.util.List getDeletedFolderList()
public java.util.List getDirectPublishResources()
Will return null
if this publish list was not initilaized for a "direct publish" but
for a project publish.
null
public java.util.List getFileList()
public java.util.List getFolderList()
public int getProjectId()
-1
if this publish list
is initialized for a "direct publish" operation.
-1
public CmsUUID getPublishHistoryId()
public boolean isDirectPublish()
public boolean isPublishSiblings()
true
if all siblings of the project resources are to be published.
true
if all siblings of the project resources are to be publishedspublic boolean isPublishSubResources()
true
if sub-resources in folders should be published (for direct publish only).
true
if sub-resources in folders should be published (for direct publish only)public java.lang.String toString()
Object.toString()
protected void addFile(CmsResource resource) throws CmsIllegalArgumentException
resource
- a new/changed/deleted Cms file resource
CmsIllegalArgumentException
- if the specified resource is not a file or unchangedprotected void addFiles(java.util.List list) throws java.lang.IllegalArgumentException
list
- a list with new/changed/deleted Cms file resources to be added to this publish list
java.lang.IllegalArgumentException
- if one of the resources is not a file or unchangedprotected void addFolder(CmsResource resource) throws java.lang.IllegalArgumentException
resource
- a new/changed Cms folder resource
java.lang.IllegalArgumentException
- if the specified resource is not a folder or unchangedprotected void addFolders(java.util.List list) throws java.lang.IllegalArgumentException
list
- a list with new/changed Cms folder resources to be added to this publish list
java.lang.IllegalArgumentException
- if one of the resources is not a folder or unchangedprotected void finalize() throws java.lang.Throwable
java.lang.Throwable
Object.finalize()
protected java.util.List getFolderListInstance()
protected void initialize()
protected boolean remove(CmsResource resource)
resource
- a Cms resource
List.remove(java.lang.Object)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |