jet.server.api
Interface ProfileManager

public interface ProfileManager

Interface ProfileManager is used to manage the profiles. Profile is predefined for user to specify available functions, a profile defined a set of functions which will be available for end-user when open a report. Only adminstrator can add/remove/update profiles.

Since:

version 8.1

Method Summary

void	addProfile(java.lang.String profileName, java.util.Properties prop, java.lang.String submitter) Add a profile, using specified profile name.
java.lang.String[]	getAllProfileNames() Get all predefined profile names.
java.util.Properties	getDefaultProfile() Get built-in default profile, which contains full functions.
java.util.Properties	getProfile(java.lang.String profileName) Get a profile by specified profile name.
void	removeProfile(java.lang.String profileName, java.lang.String submitter) Remove specified profile.
void	updateProfile(java.lang.String profileName, java.util.Properties prop, java.lang.String submitter) Update a profile using specified function list.

Method Detail

addProfile

void addProfile(java.lang.String profileName,
                java.util.Properties prop,
                java.lang.String submitter)
                throws RptServerException

Add a profile, using specified profile name.

Parameters:

profileName - the specified profile name.

prop - a Properties object that contains predefined functions of profile.

submitter - the user who request the operation, only adminstartor has permission to perform it.

Throws:

RptServerException - if a RptServerException occurs

removeProfile

void removeProfile(java.lang.String profileName,
                   java.lang.String submitter)
                   throws RptServerException

Remove specified profile.

Parameters:

profileName - the profile name.

submitter - the user who request the operation, only administrator hs permission to perform it.

Throws:

RptServerException - if a RptServerException occurs.

updateProfile

void updateProfile(java.lang.String profileName,
                   java.util.Properties prop,
                   java.lang.String submitter)
                   throws RptServerException

Update a profile using specified function list.

Parameters:

profileName - the profile name

prop - a Properties object that contains predefined fuctions need to update to profile.

submitter - the user who request the operation, only administrator has permission to perform it.

Throws:

RptServerException - if a RptServerException occurs.

getAllProfileNames

java.lang.String[] getAllProfileNames()

Get all predefined profile names.

Returns:

A String array that contains all predefined profile names.

getProfile

java.util.Properties getProfile(java.lang.String profileName)

Get a profile by specified profile name.

Returns:

A Properties object that contains predefined functions of profile.

getDefaultProfile

java.util.Properties getDefaultProfile()

Get built-in default profile, which contains full functions.

Returns:

A Properties object that contains full functions.