| java.lang.Object
 org.opencms.db.CmsPublishList
| CmsPublishList | | public CmsPublishList()(Code) | | Empty constructor.
|
| CmsPublishList | | public CmsPublishList(CmsProject project)(Code) | | Constructs a publish list for a given project.
Parameters:
project - the project to publish, this should always be the id of the current project |
| CmsPublishList | | public CmsPublishList(CmsResource directPublishResource, boolean publishSiblings)(Code) | | Constructs a publish list for a single direct publish resource.
Parameters:
directPublishResource - a VFS resource to be published directly
Parameters:
publishSiblings - indicates if all siblings of the selected resources should be published |
| CmsPublishList | | public CmsPublishList(List directPublishResources, boolean publishSiblings)(Code) | | Constructs a publish list for a list of direct publish resources.
Parameters:
directPublishResources - a list of CmsResource instances to be published directly
Parameters:
publishSiblings - indicates if all siblings of the selected resources should be published |
| CmsPublishList | | public CmsPublishList(List directPublishResources, boolean publishSiblings, boolean publishSubResources)(Code) | | Constructs a publish list for a list of direct publish resources.
Parameters:
directPublishResources - a list of CmsResource instances to be published directly
Parameters:
publishSiblings - indicates if all siblings of the selected resources should be published
Parameters:
publishSubResources - indicates if sub-resources in folders should be published (for direct publish only) |
| add | | protected void add(CmsResource resource, boolean check) throws IllegalArgumentException(Code) | | Adds a new/changed Cms folder resource to the publish list.
Parameters:
resource - a new/changed Cms folder resource
Parameters:
check - if set an exception is thrown if the specified resource is unchanged, if not set the resource is ignored
throws:
IllegalArgumentException - if the specified resource is unchanged |
| addAll | | protected void addAll(Collection resources, boolean check) throws IllegalArgumentException(Code) | | Appends all the given resources to this publish list.
Parameters:
resources - resources to be added to this publish list
Parameters:
check - if set an exception is thrown if the a resource is unchanged, if not set the resource is ignored
throws:
IllegalArgumentException - if one of the resources is unchanged |
| getAllResources | | public List getAllResources()(Code) | | Returns a list of all resources in the publish list,
including folders and files.
a list of CmsResource objects |
| getDeletedFolderList | | public List getDeletedFolderList()(Code) | | Returns a list of folder resources with the given state.
a list of folder resources with the desired state |
| getDirectPublishResources | | public List getDirectPublishResources()(Code) | | Returns the list of resources that should be published for a "direct" publish operation.
Will return null if this publish list was not initilaized for a "direct publish" but
for a project publish.
the list of resources that should be published for a "direct" publish operation, or null |
| getFileList | | public List getFileList()(Code) | | Returns an unmodifiable list of the Cms file resources in this publish list.
the list with the Cms file resources in this publish list |
| getFolderList | | public List getFolderList()(Code) | | Returns an unmodifiable list of the new/changed Cms folder resources in this publish list.
the list with the new/changed Cms file resources in this publish list |
| getProjectId | | public CmsUUID getProjectId()(Code) | | Returns the id of the project that should be published, or -1 if this publish list
is initialized for a "direct publish" operation.
the id of the project that should be published, or -1 |
| getPublishHistoryId | | public CmsUUID getPublishHistoryId()(Code) | | Returns the publish history Id for this publish list.
the publish history Id |
| initialize | | protected void initialize()(Code) | | Initializes the publish list, ensuring all internal lists are in the right order.
|
| isDirectPublish | | public boolean isDirectPublish()(Code) | | Checks if this is a publish list is used for a "direct publish" operation.
true if this is a publish list is used for a "direct publish" operation |
| isPublishSiblings | | public boolean isPublishSiblings()(Code) | | Returns true if all siblings of the project resources are to be published.
true if all siblings of the project resources are to be publisheds |
| isPublishSubResources | | public boolean isPublishSubResources()(Code) | | Returns 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) |
| remove | | protected boolean remove(CmsResource resource)(Code) | | Removes a Cms resource from the publish list.
Parameters:
resource - a Cms resource true if this publish list contains the specified resource
See Also: List.remove(java.lang.Object) |
| revive | | public void revive(CmsObject cms)(Code) | | Revives the publish list by populating the internal resource lists with CmsResource instances.
Parameters:
cms - a cms object used to read the resource instances |
| size | | public int size()(Code) | | Returns the number of all resources to be published.
the number of all resources to be published |
|
|