/*** Copyright (c), The Regents of the University of California            ***
 *** For more information please refer to files in the COPYRIGHT directory ***/
/* dataObjTrim.h - This dataObj may be generated by a program or script
 */

#ifndef DATA_OBJ_TRIM_H
#define DATA_OBJ_TRIM_H

/* This is a Object File I/O API call */

#include "rods.h"
#include "rcMisc.h"
#include "procApiRequest.h"
#include "apiNumber.h"
#include "initServer.h"
#include "dataObjWrite.h"
#include "dataObjClose.h"
#include "dataCopy.h"

#if defined(RODS_SERVER)

#define DEF_MIN_COPY_CNT	2 
#define RS_DATA_OBJ_TRIM rsDataObjTrim
/* prototype for the server handler */
int
rsDataObjTrim (rsComm_t *rsComm, dataObjInp_t *dataObjInp);
int
trimDataObjInfo (rsComm_t *rsComm, dataObjInfo_t *dataObjInfo);
#else
#define RS_DATA_OBJ_TRIM NULL
#endif

#ifdef  __cplusplus
extern "C" {
#endif

/* prototype for the client call */
/* rcDataObjTrim - Trim the copies (replica) of an iRODS data object.
 * Input -
 *   rcComm_t *conn - The client connection handle.
 *   dataObjInp_t *dataObjInp - generic dataObj input. Relevant items are:
 *      objPath - the path of the data object.
 *      condInput - conditional Input
 *	    COPIES_KW - The number of copies to retain. Default is 2. 
 *          REPL_NUM_KW  - "value" = The replica number to trim.
 *          RESC_NAME_KW - "value" = The Resource to trim.
 *          IRODS_ADMIN_KW - Admin trim other users' files.
 *   return value - The status of the operation.
 */
int
rcDataObjTrim (rcComm_t *conn, dataObjInp_t *dataObjInp);

#ifdef  __cplusplus
}
#endif

#endif	/* DATA_OBJ_TRIM_H */