com.sap.mdm.repository
Class PortStatus

java.lang.Object
  extended bycom.sap.mdm.repository.PortStatus

public class PortStatus
extends Object

A class for indicating the port status. In addition, it defines constants for the port status.


Field Summary
static int BLOCKED
          Indicates the port has been block because of a structural exception and PortProperties.isBlockOnStructuralException() is true.
static int EMPTY
          Indicates no data and no exception.
static int HAS_DATA
          Indicates the port has one or more file in the ready status.
static int HAS_EXCEPTION
          Indicates the port has some kind of exception.
static int HAS_READY
          Deprecated. replaced by HAS_DATA
static int LOCKED
          Indicates the port has been lock.
static int NONE
          Deprecated. replaced by EMPTY
 
Constructor Summary
PortStatus(PortId portId, int status)
          Constructor with the specified port status.
 
Method Summary
 int getHasDataCount()
          Returns the count for "has data".
 int getImportExceptionCount()
          Returns the count for "import exception".
 PortId getPortId()
          Returns the port Id.
 int getStructuralExceptionCount()
          Returns the count for "structural exception".
 int getValueExceptionCount()
          Returns the count for "value exception".
 boolean hasData()
          Returns true if the port has data, otherwise false.
 boolean hasException()
          Returns true if the port has at least one exception, otherwise false.
 boolean isBlocked()
          Returns true if the port is blocked (there is a structural exception and PortProperties.isBlockOnStructuralException() is true) , otherwise false.
 boolean isEmpty()
          Returns true if the port has no data, no exception and is not blocked, otherwise false.
 boolean isLocked()
          Returns true if the port is locked, otherwise false.
 void setHasDataCount(int hasDataCount)
          Sets the count for "has data".
 void setImportExceptionCount(int importExceptionCount)
          Sets the count for "import exception".
 void setStructuralExceptionCount(int structuralExceptionCount)
          Sets the count for "structural exception".
 void setValueExceptionCount(int valueExceptionCount)
          Sets the count for the "value exception".
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NONE

public static final int NONE
Deprecated. replaced by EMPTY

Indicates no status.

See Also:
Constant Field Values

EMPTY

public static final int EMPTY
Indicates no data and no exception.

Since:
5.5 SP6 Patch 04
See Also:
Constant Field Values

HAS_READY

public static final int HAS_READY
Deprecated. replaced by HAS_DATA

Indicates the port has one or more file in the ready status.

See Also:
Constant Field Values

HAS_DATA

public static final int HAS_DATA
Indicates the port has one or more file in the ready status.

Since:
5.5 SP6 Patch 04
See Also:
Constant Field Values

HAS_EXCEPTION

public static final int HAS_EXCEPTION
Indicates the port has some kind of exception.

See Also:
Constant Field Values

BLOCKED

public static final int BLOCKED
Indicates the port has been block because of a structural exception and PortProperties.isBlockOnStructuralException() is true.

See Also:
Constant Field Values

LOCKED

public static final int LOCKED
Indicates the port has been lock.

See Also:
Constant Field Values
Constructor Detail

PortStatus

public PortStatus(PortId portId,
                  int status)
Constructor with the specified port status.

Parameters:
status - port status
Since:
5.5 SP6 Patch 04
Method Detail

getPortId

public PortId getPortId()
Returns the port Id.

Returns:
port Id
Since:
5.5 SP6 Patch 04

isEmpty

public boolean isEmpty()
Returns true if the port has no data, no exception and is not blocked, otherwise false.

Returns:
true if port is empty, otherwise false
Since:
5.5 SP6 Patch 04

hasData

public boolean hasData()
Returns true if the port has data, otherwise false.

Returns:
true if the port has data, otherwise false
Since:
5.5 SP6 Patch 04

hasException

public boolean hasException()
Returns true if the port has at least one exception, otherwise false.

Returns:
true if the port has at least one exception, otherwise false.
Since:
5.5 SP6 Patch 04

isBlocked

public boolean isBlocked()
Returns true if the port is blocked (there is a structural exception and PortProperties.isBlockOnStructuralException() is true) , otherwise false.

Returns:
true if the port is blocked is true, otherwise false
Since:
5.5 SP6 Patch 04

isLocked

public boolean isLocked()
Returns true if the port is locked, otherwise false.

Returns:
true if the port is locked, otherwise false
Since:
5.5 SP6 Patch 04

getHasDataCount

public int getHasDataCount()
Returns the count for "has data".

Returns:
a count
Since:
5.5 SP6 Patch 04

setHasDataCount

public void setHasDataCount(int hasDataCount)
Sets the count for "has data".

Parameters:
hasDataCount - a count
Since:
5.5 SP6 Patch 04

getStructuralExceptionCount

public int getStructuralExceptionCount()
Returns the count for "structural exception".

Returns:
a count
Since:
5.5 SP6 Patch 04

setStructuralExceptionCount

public void setStructuralExceptionCount(int structuralExceptionCount)
Sets the count for "structural exception".

Parameters:
structuralExceptionCount - a count
Since:
5.5 SP6 Patch 04

getValueExceptionCount

public int getValueExceptionCount()
Returns the count for "value exception".

Returns:
a count
Since:
5.5 SP6 Patch 04

setValueExceptionCount

public void setValueExceptionCount(int valueExceptionCount)
Sets the count for the "value exception".

Parameters:
valueExceptionCount - a count
Since:
5.5 SP6 Patch 04

getImportExceptionCount

public int getImportExceptionCount()
Returns the count for "import exception".

Returns:
a count
Since:
5.5 SP6 Patch 04

setImportExceptionCount

public void setImportExceptionCount(int importExceptionCount)
Sets the count for "import exception".

Parameters:
importExceptionCount - a count
Since:
5.5 SP6 Patch 04


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.