com.sage.accpac.sm
Class SharedDataSet

java.lang.Object
  com.sage.accpac.sm.SharedDataSet

@ThreadSafe
public class SharedDataSet
extends java.lang.Object

Provides access to the shared data directory (FIXME or whatever else we call it). Normally an application will create an instance of this class to get a list of organizations available on the shared data set. Support for multiple shared data directories is an advanced option and requires the system to have been installed in a special way.

Thread safety

Thread-safe

Nested Class Summary

static class

SharedDataSet.PasswordStatus The possible statuses that can be returned when processing passwords (e.g.

Constructor Summary

SharedDataSet()
Provides access to the default or single shared data set.

SharedDataSet(java.lang.String directory)
Provides access to the shared data set in the specified shared data directory.

Method Summary

SharedDataSet.PasswordStatus	changePassword(java.lang.String userID, java.lang.String oldPassword, java.lang.String newPassword) attempts to change the password for the given user
SharedDataSet.PasswordStatus	checkValidLogin(java.lang.String userID, java.lang.String password) Check the user name and password, returning the status
java.lang.String	getDirectory() Gets the filesystem directory name for this directory.
Organizations	getOrganizations() Gets a list of organizations set up in the system.
java.lang.String	getSysOrg(java.lang.String company) Gets the system org ID of the given company
boolean	isSecurityEnabled(java.lang.String orgID) Is the security enabled for the given OrgID?

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedDataSet

public SharedDataSet()

Provides access to the default or single shared data set.

SharedDataSet

public SharedDataSet(java.lang.String directory)

Provides access to the shared data set in the specified shared data directory.

Parameters:

directory - the directory where the shared data is

Throws:

java.lang.NullPointerException - if the argument is a null reference

java.lang.IllegalArgumentException - if the directory is not a valid shared data directory including not having the correct form or if the file system permissions etc. do not permit enough access to the directory at this time.

Method Detail

getDirectory

public java.lang.String getDirectory()

Gets the filesystem directory name for this directory.

Returns:

the directory name

getOrganizations

public Organizations getOrganizations()

Gets a list of organizations set up in the system.

getSysOrg

public java.lang.String getSysOrg(java.lang.String company)

Gets the system org ID of the given company

Parameters:

company - company org ID

Returns:

Corresponding system org ID

Throws:

java.lang.IllegalArgumentException - if company is not known or is not a company orgID

isSecurityEnabled

public final boolean isSecurityEnabled(java.lang.String orgID)

Is the security enabled for the given OrgID?

Parameters:

orgID - Organization ID (either Company or System)

changePassword

public SharedDataSet.PasswordStatus changePassword(java.lang.String userID,
                                                   java.lang.String oldPassword,
                                                   java.lang.String newPassword)

attempts to change the password for the given user

Parameters:

userID - the ID of the user

oldPassword - the old password for the user

newPassword - the new password for the user

Returns:

the status of the request

checkValidLogin

public SharedDataSet.PasswordStatus checkValidLogin(java.lang.String userID,
                                                    java.lang.String password)

Check the user name and password, returning the status

Parameters:

userID - the ID of the user

password - the password for the user

Returns:

a SharedDataSet.PasswordStatus indicating the result. Note that there are several that reflect success.