jet.server.api.crd
Interface CubeManager

public interface CubeManager

Cube information manager.

Method Summary

void	createCube(java.lang.String loginUser, CubeInfo cubeInfo) Creates cube with specified login user and CubeInfo.
void	deleteCompletedCube(java.lang.String loginUser, int id) Deletes historical info of cube by specified login user and id.
void	deleteCompletedCube(java.lang.String loginUser, int[] ids) Deletes historical info of cube by specified login user and completed cube id.
void	deleteCube(java.lang.String loginUser, CubeInfoKey cubeKey) Deletes cube with specified login user and CubeInfoKey.
void	disableCube(java.lang.String loginUser, CubeInfoKey cubeKey) disable cube with specified login user and CubeInfoKey.
void	enableCube(java.lang.String loginUser, CubeInfoKey cubeKey) Enable cube with specified login user and CubeInfoKey.
CompletedCubeInfo	getCompletedCube(java.lang.String loginUser, int id) Gets Completed cube with specified login user and completed cube id.
CubeInfo	getCube(java.lang.String loginUser, CubeInfoKey cubeKey) Gets CubeInfo with specified login user and CubeInfoKey.
java.util.List<ParamInfo>	getParamInfos(java.lang.String loginUser, CubeInfoKey cubeKey) Gets parameter informations of specified login user and CubeInfoKey.
java.util.Vector<CompletedCubeInfo>	listCompletedCubes(java.lang.String loginUser) Gets completed cube list of specified login user.
java.util.Vector<CubeInfo>	listCubes(java.lang.String loginUser) Gets cube list with specified login user.
void	updateCube(java.lang.String loginUser, CubeInfo cubeInfo) Updates cube with specified login user and CubeInfo.

Method Detail

createCube

void createCube(java.lang.String loginUser,
                CubeInfo cubeInfo)
                throws CRDManageException

Creates cube with specified login user and CubeInfo.

Parameters:

loginUser - login user.

crdInfo - cube information.

Throws:

CRDManageException - if errors occurs when managing cube.

getCube

CubeInfo getCube(java.lang.String loginUser,
                 CubeInfoKey cubeKey)
                 throws CRDManageException

Gets CubeInfo with specified login user and CubeInfoKey.

Parameters:

loginUser - login user.

cubeKey - cube information key.

Returns:

cube information.

Throws:

CRDManageException - if errors occurs when managing cube.

deleteCube

void deleteCube(java.lang.String loginUser,
                CubeInfoKey cubeKey)
                throws CRDManageException

Deletes cube with specified login user and CubeInfoKey.

Parameters:

loginUser - login user.

cubeKey - cube information key.

Throws:

CRDManageException - if errors occurs when managing cube.

enableCube

void enableCube(java.lang.String loginUser,
                CubeInfoKey cubeKey)
                throws CRDManageException

Enable cube with specified login user and CubeInfoKey.

a disabled cube can be enabled by this method, after enable, the cube status may be CRDInfo.STATUS_PENDING, CRDInfo.STATUS_BUILDING, CRDInfo.STATUS_UPDATING, or CRDInfo.STATUS_COMPLETED.

Parameters:

loginUser - login user.

cubeKey - cube information key.

Throws:

CRDManageException - if errors occurs when managing cube.

disableCube

void disableCube(java.lang.String loginUser,
                 CubeInfoKey cubeKey)
                 throws CRDManageException

disable cube with specified login user and CubeInfoKey.

a not disabled cube can be disabled by this method, after disable, the cube status is CRDInfo.STATUS_DISABLED.

Parameters:

loginUser - login user.

cubeKey - cube information key.

Throws:

CRDManageException - if errors occurs when managing cube.

updateCube

void updateCube(java.lang.String loginUser,
                CubeInfo cubeInfo)
                throws CRDManageException

Updates cube with specified login user and CubeInfo.

Parameters:

loginUser - login user.

cubeInfo - cube information key.

Throws:

CRDManageException - if errors occurs when managing cube.

listCubes

java.util.Vector<CubeInfo> listCubes(java.lang.String loginUser)
                                     throws CRDManageException

Gets cube list with specified login user.

Parameters:

loginUser - login user.

Returns:

cube list which represents by CubeInfo.

Throws:

CRDManageException - if errors occurs when managing CRD.

deleteCompletedCube

void deleteCompletedCube(java.lang.String loginUser,
                         int id)
                         throws CRDManageException

Deletes historical info of cube by specified login user and id.

Parameters:

loginUser - login user.

id - completed cube id.

Throws:

CRDManageException - if errors occurs when managing cube.

deleteCompletedCube

void deleteCompletedCube(java.lang.String loginUser,
                         int[] ids)
                         throws CRDManageException

Deletes historical info of cube by specified login user and completed cube id.

Parameters:

loginUser - login user.

id - completed cube id array.

Throws:

CRDManageException - if errors occurs when managing cube.

getCompletedCube

CompletedCubeInfo getCompletedCube(java.lang.String loginUser,
                                   int id)
                                   throws CRDManageException

Gets Completed cube with specified login user and completed cube id.

Parameters:

loginUser - login user.

id - completed cube id.

Returns:

CompletedCRDInfo object.

Throws:

CRDManageException - if errors occurs when managing cube.

listCompletedCubes

java.util.Vector<CompletedCubeInfo> listCompletedCubes(java.lang.String loginUser)
                                                       throws CRDManageException

Gets completed cube list of specified login user.

Parameters:

loginUser - login user.

Returns:

Vector instance contains of CompletedCubeInfo.

Throws:

CRDManageException - if errors occurs when managing cube.

getParamInfos

java.util.List<ParamInfo> getParamInfos(java.lang.String loginUser,
                                        CubeInfoKey cubeKey)
                                        throws CRDManageException

Gets parameter informations of specified login user and CubeInfoKey.

Parameters:

loginUser - login user.

cubeKey - cube information key.

Returns:

List of ParamInfo.

Throws:

CRDManageException - if errors occurs when managing cube.

See Also:

ParamInfo