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

#ifndef OBJ_STAT_H
#define OBJ_STAT_H

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

#include "rods.h"
#include "procApiRequest.h"
#include "apiNumber.h"
#include "dataObjCopy.h"
#include "dataObjCopy.h"

#ifdef  __cplusplus
extern "C" {
#endif

/* rodsObjStat_t - this is similar to rodsStat_t but has minimum set of
 * parameter that are more irods specific */

typedef struct rodsObjStat {
    rodsLong_t          objSize;        /* file size */
    objType_t           objType;        /* DATA_OBJ_T or COLL_OBJ_T */
    uint                 dataMode;
    char                dataId[NAME_LEN];
    char                chksum[NAME_LEN];
    char                ownerName[NAME_LEN];
    char                ownerZone[NAME_LEN];
    char                createTime[TIME_LEN];
    char                modifyTime[TIME_LEN];
    specColl_t          *specColl;
} rodsObjStat_t;

#if defined(RODS_SERVER)
#define RS_OBJ_STAT rsObjStat

/* prototype for the server handler */
int
rsObjStat (rsComm_t *rsComm, dataObjInp_t *dataObjInp, 
rodsObjStat_t **rodsObjStatOut);
int
_rsObjStat (rsComm_t *rsComm, dataObjInp_t *dataObjInp, 
rodsObjStat_t **rodsObjStatOut);
int
_rsObjStat (rsComm_t *rsComm, dataObjInp_t *dataObjInp,
rodsObjStat_t **rodsObjStatOut);
int
dataObjStat (rsComm_t *rsComm, dataObjInp_t *dataObjInp,
rodsObjStat_t **rodsObjStatOut);
#else
#define RS_OBJ_STAT NULL
#endif

/* prototype for the client call */
/* rcObjStat - get the stat of an object specified by dataObjInp->objPath.
 * input:  dataObjInp 
 *
 * output: rodsObjStatOut
 *   The objType can be COLL_OBJ_T (collection), DATA_OBJ_T (data object) 
 *   or UNKNOWN_OBJ_T (object does not exist).  
 *   If "specColl" is not NULL, the input objPath is a Special Collection or 
 *   in a Special Collection. If objType is UNKNOWN_OBJ_T and "specColl" 
 *   is not NULL, the object does not exist but the objPath is in a 
 *   Special Collection.
 *   Important items in the specColl_t are:
 *     collClass - can be STRUCT_FILE_COLL (mounted structured file),
 *     MOUNTED_COLL (mounted collection) or LINKED_COLL (linked collection).
 *     objPath - If collClass is LINKED_COLL, this is the translated path
 *     for the input objPath. The client should use this path instead of
 *     the input "objPath" for further metadata query.
 */
int
rcObjStat (rcComm_t *conn, dataObjInp_t *dataObjInp, 
rodsObjStat_t **rodsObjStatOut);

#ifdef  __cplusplus
}
#endif

#endif	/* OBJ_STAT_H */