com.sap.mdm.repository
Class PortProperties

java.lang.Object
  extended bycom.sap.mdm.repository.PortProperties
All Implemented Interfaces:
Cloneable, NamedRepositoryItem, RepositoryItem

public class PortProperties
extends Object
implements NamedRepositoryItem

This class represents a MDM port.


Field Summary
static int AUTOMATIC_PROCESSING_TYPE
           
static int CONTINUOUS_PROCESSING_INTERVAL
           
static int DAILY_PROCESSING_INTERVAL
           
static int HOURLY_PROCESSING_INTERVAL
           
static int INBOUND
          Indicates an inbound port.
static int MANUAL_PROCESSING_TYPE
           
static int OUTBOUND
          Indicates an outbound port.
static int WEEKLY_PROCESSING_INTERVAL
           
 
Constructor Summary
PortProperties(PortId portId, RemoteSystemId remoteSystemId, MultilingualString name, String code, int type)
          Constructor with the specified parameters.
PortProperties(PortId portId, RemoteSystemId remoteSystemId, MultilingualString name, String code, int type, boolean isBlockOnStructuralException)
          Constructor with the specified parameters.
PortProperties(PortId portId, RemoteSystemId remoteSystemId, MultilingualString name, String code, int type, boolean isBlockOnStructuralException, boolean isActive)
          Constructor with the specified parameters.
PortProperties(PortProperties other)
          Copy constructor.
 
Method Summary
 Object clone()
           
 boolean equals(Object obj)
           
 String getCode()
          Returns a string identifier for a named repository object.
 int getFileAggregationCount()
          Returns the file aggregation count.
 PortId getId()
          Returns the port Id.
 MultilingualString getName()
          Returns the port name.
 Calendar getNextSyndicationTime()
          Returns the next syndication time in GMT.
 PortMapId getPortMapId()
          Returns the port map Id.
 int getProcessingInternval()
          Returns the processing interval.
 int getProcessingType()
          Returns the processing type.
 RemoteSystemId getRemoteSystemId()
          Returns the remote system Id.
 SourceFormat getSourceFormat()
          Returns the source format.
 int getType()
          Returns the port type, inbound or outbound
 String getTypeName()
          Returns the port type as a string.
static String getTypeName(int type)
          Returns the port type as a string.
 int hashCode()
           
 boolean isActive()
          Indicates if the port is active
 boolean isBlockOnStructuralException()
          Indicates the port is block when there is a structural exception, otherwise don't block the port.
 void setBlockOnStructuralException(boolean isBlockOnStructuralException)
          Sets whether the port is block when there is a structural exception, otherwise don't block the port.
 void setCode(String code)
           
 void setFileAggregationCount(int count)
          Sets the file aggregation count.
 void setId(PortId id)
          Sets the port Id.
 void setIsActive(boolean isActive)
          Sets whether the port is active
 void setName(MultilingualString name)
           
 void setNextSyndicationTime(Calendar time)
          Sets the next syndication time in GMT.
 void setPortMapId(PortMapId portMapId)
          Sets the port map Id
 void setProcessingInternval(int processingInterval)
          Sets the processing interval.
 void setProcessingType(int processingType)
          Sets the processing type.
 void setRemoteSystemId(RemoteSystemId remoteSystemId)
           
 void setSourceFormat(SourceFormat sourceFormat)
          Sets the source format.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INBOUND

public static final int INBOUND
Indicates an inbound port.

See Also:
getType(), Constant Field Values

OUTBOUND

public static final int OUTBOUND
Indicates an outbound port.

See Also:
getType(), Constant Field Values

AUTOMATIC_PROCESSING_TYPE

public static final int AUTOMATIC_PROCESSING_TYPE
See Also:
Constant Field Values

MANUAL_PROCESSING_TYPE

public static final int MANUAL_PROCESSING_TYPE
See Also:
Constant Field Values

CONTINUOUS_PROCESSING_INTERVAL

public static final int CONTINUOUS_PROCESSING_INTERVAL
See Also:
Constant Field Values

HOURLY_PROCESSING_INTERVAL

public static final int HOURLY_PROCESSING_INTERVAL
See Also:
Constant Field Values

DAILY_PROCESSING_INTERVAL

public static final int DAILY_PROCESSING_INTERVAL
See Also:
Constant Field Values

WEEKLY_PROCESSING_INTERVAL

public static final int WEEKLY_PROCESSING_INTERVAL
See Also:
Constant Field Values
Constructor Detail

PortProperties

public PortProperties(PortId portId,
                      RemoteSystemId remoteSystemId,
                      MultilingualString name,
                      String code,
                      int type)
Constructor with the specified parameters.

Parameters:
portId - a port Id
remoteSystemId - a remote system Id
name - the port name
code - the coding port name
type - port type

PortProperties

public PortProperties(PortId portId,
                      RemoteSystemId remoteSystemId,
                      MultilingualString name,
                      String code,
                      int type,
                      boolean isBlockOnStructuralException)
Constructor with the specified parameters.

Parameters:
portId - a port Id
remoteSystemId - a remote system Id
name - the port name
code - the coding port name
type - port type
isBlockOnStructuralException - flag indicating to block or not
Since:
5.5 SP6 Patch 04

PortProperties

public PortProperties(PortId portId,
                      RemoteSystemId remoteSystemId,
                      MultilingualString name,
                      String code,
                      int type,
                      boolean isBlockOnStructuralException,
                      boolean isActive)
Constructor with the specified parameters.

Parameters:
portId - a port Id
remoteSystemId - a remote system Id
name - the port name
code - the coding port name
type - port type
isBlockOnStructuralException - flag indicating to block or not
isActive - flag indicating is the port active
Since:
5.5 SP6 Patch 04

PortProperties

public PortProperties(PortProperties other)
Copy constructor. Creates deep copy of PortProperties object.

Parameters:
other - object to copy
Since:
7.1 SP 04
Method Detail

getCode

public String getCode()
Description copied from interface: NamedRepositoryItem
Returns a string identifier for a named repository object.

Specified by:
getCode in interface NamedRepositoryItem
Returns:
the code name

setCode

public void setCode(String code)
Parameters:
code -
Since:
7.1 SP 05

getName

public MultilingualString getName()
Returns the port name.

Returns:
a port name

setName

public void setName(MultilingualString name)
Parameters:
name -
Since:
7.1 SP 05

getId

public PortId getId()
Returns the port Id.

Returns:
a port Id

setId

public void setId(PortId id)
Sets the port Id.

Parameters:
id - port Id
Since:
7.1 SP5

getRemoteSystemId

public RemoteSystemId getRemoteSystemId()
Returns the remote system Id.

Returns:
a remote system Id

setRemoteSystemId

public void setRemoteSystemId(RemoteSystemId remoteSystemId)
Parameters:
remoteSystemId -
Since:
7.1 SP 05

getType

public int getType()
Returns the port type, inbound or outbound

Returns:
the port type
See Also:
INBOUND, OUTBOUND

getTypeName

public String getTypeName()
Returns the port type as a string.

Returns:
the port type.

getTypeName

public static String getTypeName(int type)
Returns the port type as a string.

Parameters:
type - the port type
Returns:
the port type.

isBlockOnStructuralException

public boolean isBlockOnStructuralException()
Indicates the port is block when there is a structural exception, otherwise don't block the port.

Returns:
true to block, otherwise false
Since:
5.5 SP6 Patch 04

setBlockOnStructuralException

public void setBlockOnStructuralException(boolean isBlockOnStructuralException)
Sets whether the port is block when there is a structural exception, otherwise don't block the port. This is only for inbound port.

Parameters:
isBlockOnStructuralException -
Since:
7.1 SP 05

isActive

public boolean isActive()
Indicates if the port is active

Returns:
true if active, otherwise false
Since:
7.1 SP16

setIsActive

public void setIsActive(boolean isActive)
Sets whether the port is active

Parameters:
isActive -
Since:
7.1 SP 16

getSourceFormat

public SourceFormat getSourceFormat()
Returns the source format.

Returns:
a source format
Since:
7.1 SP 05

setSourceFormat

public void setSourceFormat(SourceFormat sourceFormat)
Sets the source format.

Parameters:
sourceFormat - a source format
Since:
7.1 SP 05
See Also:
DelimitedTextSourceFormat, FixedTextSourceFormat, XMLSchemaSourceFormat

getPortMapId

public PortMapId getPortMapId()
Returns the port map Id.

Returns:
a port map Id
Since:
7.1 SP 05

setPortMapId

public void setPortMapId(PortMapId portMapId)
Sets the port map Id

Parameters:
portMapId - a port map Id
Since:
7.1 SP 05

getProcessingType

public int getProcessingType()
Returns the processing type.

Returns:
a type
Since:
7.1 SP 05

setProcessingType

public void setProcessingType(int processingType)
Sets the processing type. The default is AUTOMATIC_PROCESSING_TYPE.

Parameters:
processingType - type
Since:
7.1 SP 05
See Also:
AUTOMATIC_PROCESSING_TYPE, MANUAL_PROCESSING_TYPE

getProcessingInternval

public int getProcessingInternval()
Returns the processing interval.

Returns:
an interval
Since:
7.1 SP 05

setProcessingInternval

public void setProcessingInternval(int processingInterval)
Sets the processing interval. It only applies to OUTBOUND ports and the processing type is automatic. The default is CONTINUOUS_PROCESSING_INTERVAL.

Parameters:
processingInterval -
Since:
7.1 SP 05
See Also:
CONTINUOUS_PROCESSING_INTERVAL, HOURLY_PROCESSING_INTERVAL, DAILY_PROCESSING_INTERVAL, WEEKLY_PROCESSING_INTERVAL, setProcessingType(int)

getFileAggregationCount

public int getFileAggregationCount()
Returns the file aggregation count.

Returns:
a count
Since:
7.1 SP 05

setFileAggregationCount

public void setFileAggregationCount(int count)
Sets the file aggregation count. It only applies to INBOUND ports and for file-based source format.

Parameters:
count - a count
Since:
7.1 SP 05
See Also:
SourceFormat

getNextSyndicationTime

public Calendar getNextSyndicationTime()
Returns the next syndication time in GMT.

Returns:
a GMT time
Since:
7.1 SP 05

setNextSyndicationTime

public void setNextSyndicationTime(Calendar time)
Sets the next syndication time in GMT.

Parameters:
time - a GMT time
Since:
7.1 SP 05

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

toString

public String toString()

clone

public Object clone()


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.