com.sap.netweaver.bc.rf.common.support
Class NameInfo

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.common.support.NameInfo

public class NameInfo

extends java.lang.Object

This object contains information about the restrictions for resource and collection names of a specific repository. This information should be provided by any repository via the IRepositoryManager.getNameInfo() method.

The implementation of this object ensures that the WCM framework's restrictions are added. The WCM framework enforced the following restrictions on the namespace of all repositories for new resources and collections. Reserved/forbidden characters in resource and collection names: '/', '\', '?' Maximum length of name and path: 2048 characters

Copyright (c) 2003 by SAP AG. All Rights Reserved.

Constructor Summary

NameInfo(char[] resNameChars, char[] collNameChars, int maxNameLength, int maxPathLength)
Construct a new name info

Method Summary

void	checkName(java.lang.String name) Throws an exception if the specified name is invalid.
int	getMaxNameLength() Returns the maximum length for resource names
int	getMaxPathLength() Returns the maximum path length
char[]	getReservedCollectionNameChars() Returns the array of reserved or forbidden characters in collection names
char[]	getReservedResourceNameChars() Returns the array of reserved or forbidden characters in resource names
java.lang.String	toString() TBD: Description of the Method.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameInfo

public NameInfo(char[] resNameChars,
                char[] collNameChars,
                int maxNameLength,
                int maxPathLength)

Construct a new name info

Parameters:

resNameChars - An array of reserved or forbidden characters in resource names

collNameChars - An array of reserved or forbidden characters in collection names

maxNameLength - The maximum length for resource names.

maxPathLength - The maximum path length

Method Detail

getReservedResourceNameChars

public char[] getReservedResourceNameChars()

Returns the array of reserved or forbidden characters in resource names

Returns:

The reservedResourceNameChars value

getReservedCollectionNameChars

public char[] getReservedCollectionNameChars()

Returns the array of reserved or forbidden characters in collection names

Returns:

The reservedCollectionNameChars value

getMaxNameLength

public int getMaxNameLength()

Returns the maximum length for resource names

Returns:

The maxNameLength value

getMaxPathLength

public int getMaxPathLength()

Returns the maximum path length

Returns:

The maxPathLength value

toString

public java.lang.String toString()

TBD: Description of the Method.

Overrides:

toString in class java.lang.Object

Returns:

TBD: Description of the outgoing return value

checkName

public void checkName(java.lang.String name)
               throws RepositoryException

Throws an exception if the specified name is invalid.

Parameters:

name - The name to check.

Throws:

RepositoryException - If the name is invalid.