/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see .
*/
package org.alfresco.repo.domain.contentdata;
import java.util.List;
import java.util.Set;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.util.Pair;
import org.springframework.dao.ConcurrencyFailureException;
import org.springframework.dao.DataIntegrityViolationException;
/**
* DAO services for alf_content_data table
*
* @author Derek Hulley
* @since 3.2
*/
public interface ContentDataDAO
{
/**
* Create a new ContentData instance.
*
* @param contentData the ContentData details
* @return the ContentData pair (id, ContentData) (never null)
*/
Pair createContentData(ContentData contentData);
/**
* Update a content data instance
*
* @param id the unique ID of the entity
* @param contentData the new data
*/
void updateContentData(Long id, ContentData contentData);
/**
* Creates an immediately-orphaned content URL, if possible
*
* @param contentUrl the URL to create if it doesn't exist
* @return Returns the ID-URL pair
* @throws DataIntegrityViolationException if the URL already exists
*/
Pair createContentUrlOrphaned(String contentUrl);
/**
* @param id the unique ID of the entity
* @return the ContentData pair (id, ContentData) or null if it doesn't exist
* @throws AlfrescoRuntimeException if the ID provided is invalid
*/
Pair getContentData(Long id);
/**
* Delete an instance of content.
* @param id the unique ID of the entity
* @throws ConcurrencyFailureException if the ID does not exist
*/
void deleteContentData(Long id);
/**
* Deletes all alf_content_data rows that are referenced by the given node
*
* @param nodeId the node ID
* @param qnameIds the content properties to target
*/
void deleteContentDataForNode(Long nodeId, Set qnameIds);
/**
* Interface for callbacks during content URL enumeration
*
* @author Derek Hulley
* @since 3.2
*/
public static interface ContentUrlHandler
{
void handle(Long id, String contentUrl, Long orphanTime);
}
/**
* Enumerate all available content URLs that were orphaned on or before the given time
*
* @param contentUrlHandler the callback object to process the rows
* @param maxOrphanTime the maximum orphan time
*/
void getContentUrlsOrphaned(ContentUrlHandler contentUrlHandler, long maxOrphanTime);
/**
* Enumerate all available content URLs that were orphaned on or before the given time
*
* @param contentUrlHandler the callback object to process the rows
* @param maxOrphanTime the maximum orphan time
* @param maxResults the maximum number of results (1 or greater)
*/
void getContentUrlsOrphaned(ContentUrlHandler contentUrlHandler, long maxOrphanTime, int maxResults);
/**
* Delete a batch of content URL entities.
*/
int deleteContentUrls(List ids);
}