oracle.epm.fm.domainobject.administration

Class AdministrationOM

java.lang.Object

oracle.epm.fm.domainobject.administration.AdministrationOM

All Implemented Interfaces:

Serializable

public class AdministrationOM
extends Object
implements Serializable

This class contains all Administration related APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdministrationOM(SessionInfo sessionInfo) Creates an instance of the AdministrationOM object.

Method Summary

Modifier and Type	Method and Description
void	deleteDataAuditRecords(DataAuditFilter dataAuditfilter) This method is to delete the data audit records based on the filter.
void	deleteTaskAuditRecords(TaskAuditFilter taskAuditFilter) This method is to delete the task audit records based on the filter.
File	downloadTaskAuditAttachment(String taskAuditId) Method to extract TaskAudit Attachment and download it to File Transfer Folder.
List<String>	enumActivityUser(boolean forRunningTasks) Method to get the activity users.
List<DataAuditRecord>	enumDataAuditRecords(DataAuditFilter dataAuditFilter) This method will enumerate the data.
List<RunningTask>	enumRunningTask(RunningTaskFilter filter) Method helps to get the running tasks based on the filter.
List<TaskAuditRecord>	enumTaskAuditRecords(TaskAuditFilter taskAuditFilter) This method will enumerate the tasks.
File	extractDataAuditRecords(DataAuditFilter dataAuditfilter) This method is to extract the data audit records based on the filter.
File	extractTaskAuditRecords(TaskAuditFilter taskAuditfilter) This method is to extract the task audit records based on the filter.
List<RunningTaskProgress>	getCurrentTaskProgress(List<Integer> taskIDs) Method to get the running task progress.
long	getDataAuditRecordsSize(DataAuditFilter dataAuditFilter) This method will enumerate the data and retrieves the size.
File	getRunningTaskFile(int runningTaskID) Method helps to download the file from running task based on runningTaskID drom same server.
File	getRunningTaskFileFromServer(String fileId, String serverName, int runningTaskId) Method helps to download running task file from distributed machine based on fileId and server name.
RunningTaskLogPathAndServerName	getRunningTaskFileInfo(int runningTaskID) Method helps to retrieve the running task log path and sever name.
File	getRunningTaskLog(int runningTaskID) Method helps to download the log file from running task based on runningTaskID.
long	getRunningTaskSize(RunningTaskFilter filter) Method helps to get the number of running tasks based on the filter.
long	getTaskAuditRecordsSize(TaskAuditFilter taskAuditFilter) This method will enumerate the tasks and retrieves the size.
boolean	hasSystemChanged() This method returns true if system has changed.
void	stopRunningTask(List<Integer> taskIDs) Method to stop the running tasks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdministrationOM

public AdministrationOM(SessionInfo sessionInfo)
                 throws HFMException

Creates an instance of the AdministrationOM object.

Parameters:

sessionInfo - session information

Throws:

HFMException

Method Detail

getRunningTaskSize

public long getRunningTaskSize(RunningTaskFilter filter)
                        throws HFMException

Method helps to get the number of running tasks based on the filter.

Parameters:

filter - - running task filter applied

Returns:

the size of the running tasks

Throws:

HFMException

enumRunningTask

public List<RunningTask> enumRunningTask(RunningTaskFilter filter)
                                  throws HFMException

Method helps to get the running tasks based on the filter.

Parameters:

filter - - running task filter applied

Returns:

list of running task objects

Throws:

HFMException

getRunningTaskFileFromServer

public File getRunningTaskFileFromServer(String fileId,
                                         String serverName,
                                         int runningTaskId)
                                  throws HFMException

Method helps to download running task file from distributed machine based on fileId and server name.

Parameters:

fileId - - running task returned log file or data file Id

serverName - - running task returned server name for

runningTaskId - - running task Id

Returns:

file object

Throws:

HFMException

getRunningTaskLog

public File getRunningTaskLog(int runningTaskID)
                       throws HFMException

Method helps to download the log file from running task based on runningTaskID.

Parameters:

runningTaskID - - running task Id

Returns:

file object

Throws:

HFMException

getRunningTaskFile

public File getRunningTaskFile(int runningTaskID)
                        throws HFMException

Method helps to download the file from running task based on runningTaskID drom same server.

Parameters:

runningTaskID - - running task Id

Returns:

file object

Throws:

HFMException

getRunningTaskFileInfo

public RunningTaskLogPathAndServerName getRunningTaskFileInfo(int runningTaskID)
                                                       throws HFMException

Method helps to retrieve the running task log path and sever name.

Parameters:

runningTaskID - - running task Id

Returns:

object contains the log patha and sever name info

Throws:

HFMException

stopRunningTask

public void stopRunningTask(List<Integer> taskIDs)
                     throws HFMException

Method to stop the running tasks.

Parameters:

taskIDs - - list of task Ids

Throws:

HFMException

getCurrentTaskProgress

public List<RunningTaskProgress> getCurrentTaskProgress(List<Integer> taskIDs)
                                                 throws HFMException

Method to get the running task progress.

Parameters:

taskIDs - - list of task Ids

Returns:

running task progress object having the task progress details

Throws:

HFMException

enumActivityUser

public List<String> enumActivityUser(boolean forRunningTasks)
                              throws HFMException

Method to get the activity users.

Parameters:

forRunningTasks - decides if the user is for the running tasks

Returns:

list of users

Throws:

HFMException

getTaskAuditRecordsSize

public long getTaskAuditRecordsSize(TaskAuditFilter taskAuditFilter)
                             throws HFMException

This method will enumerate the tasks and retrieves the size.

Parameters:

taskAuditFilter - the filter for task audit.

Returns:

long size.

Throws:

HFMException

getDataAuditRecordsSize

public long getDataAuditRecordsSize(DataAuditFilter dataAuditFilter)
                             throws HFMException

This method will enumerate the data and retrieves the size.

Parameters:

dataAuditFilter - the filter for data audit.

Returns:

long size.

Throws:

HFMException

enumTaskAuditRecords

public List<TaskAuditRecord> enumTaskAuditRecords(TaskAuditFilter taskAuditFilter)
                                           throws HFMException

This method will enumerate the tasks.

Parameters:

taskAuditFilter - the filter for task audit.

Returns:

TaskAuditRecord list of taskauditrecord objects.

Throws:

HFMException

enumDataAuditRecords

public List<DataAuditRecord> enumDataAuditRecords(DataAuditFilter dataAuditFilter)
                                           throws HFMException

This method will enumerate the data.

Parameters:

dataAuditFilter - the filter for data audit.

Returns:

DataAuditRecord list of dataauditrecord objects.

Throws:

HFMException

deleteTaskAuditRecords

public void deleteTaskAuditRecords(TaskAuditFilter taskAuditFilter)
                            throws HFMException

This method is to delete the task audit records based on the filter.

Parameters:

taskAuditFilter - the filter for task audit records.

Throws:

HFMException

deleteDataAuditRecords

public void deleteDataAuditRecords(DataAuditFilter dataAuditfilter)
                            throws HFMException

This method is to delete the data audit records based on the filter.

Parameters:

dataAuditfilter - the filter for data audit records.

Throws:

HFMException

extractTaskAuditRecords

public File extractTaskAuditRecords(TaskAuditFilter taskAuditfilter)
                             throws HFMException

This method is to extract the task audit records based on the filter.

Parameters:

taskAuditfilter - the filter for task audit records.

Returns:

file object.

Throws:

HFMException

extractDataAuditRecords

public File extractDataAuditRecords(DataAuditFilter dataAuditfilter)
                             throws HFMException

This method is to extract the data audit records based on the filter.

Parameters:

dataAuditfilter - the filter for data audit records.

Returns:

file object.

Throws:

HFMException

downloadTaskAuditAttachment

public File downloadTaskAuditAttachment(String taskAuditId)
                                 throws HFMException

Method to extract TaskAudit Attachment and download it to File Transfer Folder.

Parameters:

taskAuditId - the Id of the task

Returns:

File object.

Throws:

HFMException

hasSystemChanged

public boolean hasSystemChanged()
                         throws HFMException

This method returns true if system has changed. System change happens when action like load metadata is performed. User may have to re-login if the system has changed.

Returns:

true/false.

Throws:

HFMException