com.hp.ucmdb.api.view.archive

Interface ViewArchiveService

public interface ViewArchiveService

Provides services for archiving view results

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
ArchivedViewId	archiveView(String viewName, String description) Archives a view and returns ID of the created archive
boolean	deleteArchivedView(ArchivedViewId archiveId) Deletes archived view
int	deleteArchivedViews(ArchivedViewQuery query) Deletes archived views by specified query
ArchivedView	getArchivedView(ArchivedViewId archiveId) Returns archived view by ID
ArchivedViewFactory	getFactory() Returns factory for supporting entities
List<ArchivedViewHeader>	listArchivedViews(ArchivedViewQuery query) Queries for archived views and returns headers of requested archives

Method Detail

getFactory

ArchivedViewFactory getFactory()

Returns factory for supporting entities

Returns:

factory for supporting entities

listArchivedViews

List<ArchivedViewHeader> listArchivedViews(ArchivedViewQuery query)

Queries for archived views and returns headers of requested archives

Parameters:

query - defines archives to query

Returns:

headers of the requested archives

getArchivedView

ArchivedView getArchivedView(ArchivedViewId archiveId)

Returns archived view by ID

Parameters:

archiveId - the id of archived view

Returns:

archived view

deleteArchivedView

boolean deleteArchivedView(ArchivedViewId archiveId)

Deletes archived view

Parameters:

archiveId - the id of archived view

Returns:

true if the archive was deleted, false otherwise

deleteArchivedViews

int deleteArchivedViews(ArchivedViewQuery query)

Deletes archived views by specified query

Parameters:

query - defines archived views to delete

Returns:

number of deleted archived views

archiveView

ArchivedViewId archiveView(String viewName,
                           String description)

Archives a view and returns ID of the created archive

Parameters:

viewName - the name of view to archive

description - archive description

Returns:

the ID of the created archive