rapture.common.api.SysApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.RaptureFolderInfo;
import rapture.common.NodeEnum;
import rapture.common.ChildrenTransferObject;
import rapture.common.model.DocumentWithMeta;
import rapture.common.ConnectionInfo;


@SuppressWarnings("all")
public interface SysApi {
     /**
     * Retrieve a system config
     * 
     */
     String retrieveSystemConfig(CallingContext context, String area, String path);

     /**
     * Write a system config
     * 
     */
     String writeSystemConfig(CallingContext context, String area, String path, String content);

     /**
     * Remove a system document
     * 
     */
     void removeSystemConfig(CallingContext context, String area, String path);

     /**
     * Gets the hiearchy (the documents below this point, like with user.getChildren)
     * 
     */
     List getSystemFolders(CallingContext context, String area, String path);

     /**
     * Retrieve all top level repos
     * 
     */
     List getAllTopLevelRepos(CallingContext context);

     /**
     * Get children from the specified point.URI Cannot be null, but it can be the IndexMark
     * from the ChildrenTransferObject returned by a previous call. depth indicates the
     * number of levels to retrieve data for. If maximum > 0 then cap the number of entries
     * returnedif there are more results than the defined maximum then store the remainder
     * in the cache for quick access next time. The cache will expire after timeToLive
     * milliseconds. If a zero or negative value is supplied then the configured default
     * will be used. If refresh is true and there are more results than the defined maximum
     * then keep track of the values that have been returned. On the next call re-read
     * the tree and return only new entries.This is much slower than without refresh because
     * the tree is re-read each time.
     * 
     */
     ChildrenTransferObject listByUriPrefix(CallingContext context, String raptureURI, String marker, int depth, Long maximum, Long millisUntilCacheExpiry);

     /**
     * Retrieve all the immediate children of a URI
     * 
     */
     ChildrenTransferObject getChildren(CallingContext context, String raptureURI);

     /**
     * Retrieve all the children of a URI, spanning multiple levels. The page size must
     * be specified. If refresh is false and there are more results than the defined
     * page size then store the remainder in the cache for quick access next time If
     * refresh is true and there are more results than the defined maximum then keep track
     * of the values that have been returned. On the next call re-read the tree and return
     * only new entries. This is slower than without refresh because the tree is re-read
     * each time.
     * 
     */
     ChildrenTransferObject getAllChildren(CallingContext context, String raptureURI, String marker, Long maximum);

     /**
     * Determine whether the URI references an object, a folder, both or neither
     * 
     */
     NodeEnum getFolderInfo(CallingContext context, String raptureURI);

     /**
     * Gets connection info of given connection type.
     * 
     */
     Map getConnectionInfo(CallingContext context, String connectionType);

     /**
     * Puts connection info of an instance.
     * 
     */
     void putConnectionInfo(CallingContext context, String connectionType, ConnectionInfo connectionInfo);

     /**
     * Sets connection info of an instance.
     * 
     */
     void setConnectionInfo(CallingContext context, String connectionType, ConnectionInfo connectionInfo);

     /**
     * Retrieves the metadata for a storable object. e.g. script, workflow, workorder
     * 
     */
     DocumentWithMeta getSysDocumentMeta(CallingContext context, String raptureURI);

}