alfresco-community-repo/source/java/org/alfresco/cmis/CMISChangeLogService.java
David Caruana fbd7aab3b1 Merging BRANCHES/DEV/CMIS_10 to HEAD (phase 2 - currently up-to-date with branch):
18717: SAIL-166: Refactor CMIS to use shared services and resolve objectIds and error codes consistently
   18731: SAIL-169: CMIS REST versioning compliance
   18732: Fix failing change log test.
   18768: Add displayName and queryName attributes to rendered properties (in CMIS AtomPub binding).
   18775: Fix exception reporting when retrieving items that do not exist (in CMIS AtomPub binding).
   18784: Fix CMIS REST change logging
   18785: SAIL-174: CMIS Relationship lookup by association ID
   18812: SAIL-183: Support orderBy argument for getChildren and getCheckedOutDocs in CMIS REST and Web Service bindings
   18823: CMIS WS Bindings were moved to 1.0 cd07 schema.
   18838: Update to latest Chemistry TCK.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18847 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-02-25 15:02:44 +00:00

87 lines
3.5 KiB
Java
Executable File

/*
* Copyright (C) 2005-2009 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.cmis;
import java.util.List;
/**
* Service for manipulating with <b>Change Log Events</b> by <b>Change Log Tokens</b>. Also this service exposes some methods for describing <b>Auditing</b> features
*
* @author Dmitry Velichkevich
*/
public interface CMISChangeLogService
{
/**
* @param changeLogToken - {@link String} value that represents some <b>Change Log Token</b>
* @param maxItems - {@link Integer} value that determines required amount of entries
* @return {@link CMISChangeLog} instance that describes entry mapped to specified <b>Change Log Token</b>
* @throws CMISInvalidArgumentException
*/
public CMISChangeLog getChangeLogEvents(String changeLogToken, Integer maxItems) throws CMISInvalidArgumentException;
/**
* @return {@link String} value that represents <b>Change Log Token</b> which is currently actual
*/
public String getLastChangeLogToken();
/**
* Gets the change log token maxItems entries before the given one
*
* @param currentPageToken
* a change log token
* @param maxItems
* the number of entries to skip backwards
* @return the change log token maxItems entries before currentPageToken
*/
public String getPreviousPageChangeLogToken(String currentPageToken, Integer maxItems);
/**
* Assuming that currentPageToken begins a page of maxItems entries, gets the token at the start of the final page.
*
* @param currentPageToken
* a change log token
* @param maxItems
* the number of entries per page
* @return the change log token at the start of the final page
*/
public String getLastPageChangeLogToken(String currentPageToken, Integer maxItems);
/**
* @return {@link CMISCapabilityChanges} <b>enum</b> value that specifies currently configured <b>Auditing</b> feature mode
*/
public CMISCapabilityChanges getCapability();
/**
* @return {@link List}&lt;{@link CMISBaseObjectTypeIds}&gt; collection instance that contains configured value for Changes On Type capability
* @see CMISBaseObjectTypeIds
*/
public List<CMISBaseObjectTypeIds> getChangesOnTypeCapability();
/**
* @return always <b>true</b>
*/
public boolean getChangesIncomplete();
}