com.sas.metadata.remote
Interface MdRepositoryUtil

All Superinterfaces:
java.rmi.Remote

public interface MdRepositoryUtil
extends java.rmi.Remote

The interface defining the utility class for retrieving repository information.


Field Summary
static java.lang.String CUSTOM_REPOS
          Custom repository type
static java.lang.String FOUNDATION_REPOS
          Foundation repository type
static java.lang.String PROJECT_REPOS
          Project repository type
 
Method Summary
 void dispose()
          Destroy all memory allocated for object and release from RMI
 java.util.List getDependentRepositories(java.lang.String repositoryID)
          Gets a list of any dependent repositories that may exist the specified repository.
 java.lang.String getRepositoryIDFromName(java.lang.String name)
          Get the id for a repository given the repository name
 java.lang.String getRepositoryName(java.lang.String repositoryID)
          Gets the name of a repository given its id.
 java.lang.String getRepositoryType(java.lang.String repositoryID)
          Gets the type of a repository given the repository id.
 java.util.List getUsedByRepositories(java.lang.String repositoryID)
          Gets a list of repositories that use the specified repository.
 boolean hasDependentRepositories(java.lang.String repositoryID)
          Returns true if the given repository has any dependent repositories
 boolean isCustomType(java.lang.String repositoryID)
          Returns true if the repository is a Custom repository
 boolean isDependentRepository(java.lang.String repositoryID)
          Returns true if the given repository is a dependent repository.
 boolean isFoundationType(java.lang.String repositoryID)
          Returns true if the repository is a Foundation repository
 boolean isProjectType(java.lang.String repositoryID)
          Returns true if the repository is a Project repository
 

Field Detail

FOUNDATION_REPOS

static final java.lang.String FOUNDATION_REPOS
Foundation repository type

See Also:
Constant Field Values

CUSTOM_REPOS

static final java.lang.String CUSTOM_REPOS
Custom repository type

See Also:
Constant Field Values

PROJECT_REPOS

static final java.lang.String PROJECT_REPOS
Project repository type

See Also:
Constant Field Values
Method Detail

dispose

void dispose()
             throws java.rmi.RemoteException
Destroy all memory allocated for object and release from RMI

Throws:
java.rmi.RemoteException

getRepositoryType

java.lang.String getRepositoryType(java.lang.String repositoryID)
                                   throws MdException,
                                          java.rmi.RemoteException
Gets the type of a repository given the repository id. Repository types returned include Foundation, Custom, or Project. A null is returned if the repository type cannot be found.

Parameters:
repositoryID - the repository id
Returns:
the type of repository
Throws:
MdException
java.rmi.RemoteException

getRepositoryIDFromName

java.lang.String getRepositoryIDFromName(java.lang.String name)
                                         throws MdException,
                                                java.rmi.RemoteException
Get the id for a repository given the repository name

Parameters:
name - the name of the repository
Returns:
the repository id
Throws:
MdException
java.rmi.RemoteException

getRepositoryName

java.lang.String getRepositoryName(java.lang.String repositoryID)
                                   throws MdException,
                                          java.rmi.RemoteException
Gets the name of a repository given its id.

Parameters:
repositoryID - the repository id
Returns:
the name of a the repository
Throws:
MdException
java.rmi.RemoteException

getDependentRepositories

java.util.List getDependentRepositories(java.lang.String repositoryID)
                                        throws MdException,
                                               java.rmi.RemoteException
Gets a list of any dependent repositories that may exist the specified repository.

Parameters:
repositoryID - the repository id
Returns:
a list of dependent repository ids
Throws:
MdException
java.rmi.RemoteException

getUsedByRepositories

java.util.List getUsedByRepositories(java.lang.String repositoryID)
                                     throws MdException,
                                            java.rmi.RemoteException
Gets a list of repositories that use the specified repository.

Parameters:
repositoryID - the repository id
Returns:
a list of used by repository ids
Throws:
MdException
java.rmi.RemoteException

isDependentRepository

boolean isDependentRepository(java.lang.String repositoryID)
                              throws MdException,
                                     java.rmi.RemoteException
Returns true if the given repository is a dependent repository.

Parameters:
repositoryID - the repository id
Returns:
true if the repository is a dependent
Throws:
MdException
java.rmi.RemoteException

hasDependentRepositories

boolean hasDependentRepositories(java.lang.String repositoryID)
                                 throws MdException,
                                        java.rmi.RemoteException
Returns true if the given repository has any dependent repositories

Parameters:
repositoryID - the repository id
Returns:
true if there are dependent repositories
Throws:
MdException
java.rmi.RemoteException

isFoundationType

boolean isFoundationType(java.lang.String repositoryID)
                         throws MdException,
                                java.rmi.RemoteException
Returns true if the repository is a Foundation repository

Parameters:
repositoryID - the repository id
Returns:
true if the type is equal to Foundation, false otherwise
Throws:
MdException
java.rmi.RemoteException

isCustomType

boolean isCustomType(java.lang.String repositoryID)
                     throws MdException,
                            java.rmi.RemoteException
Returns true if the repository is a Custom repository

Parameters:
repositoryID - the repository id
Returns:
true if the type is equal to Custom, false otherwise
Throws:
MdException
java.rmi.RemoteException

isProjectType

boolean isProjectType(java.lang.String repositoryID)
                      throws MdException,
                             java.rmi.RemoteException
Returns true if the repository is a Project repository

Parameters:
repositoryID - the repository id
Returns:
true if the type is equal to Project, false otherwise
Throws:
MdException
java.rmi.RemoteException



Copyright © 2009 SAS Institute Inc. All Rights Reserved.