wt.part
Class StandardLineNumberService

java.lang.Object
  extended by wt.services.StandardManager
      extended by wt.part.StandardLineNumberService
All Implemented Interfaces:
Serializable, NetFactor, LineNumberService, wt.services.Manager

public class StandardLineNumberService
extends StandardManager
implements LineNumberService, Serializable

Use the newStandardLineNumberService static factory method(s), not the StandardLineNumberService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:
Serialized Form

Method Summary
 Hashtable findAllPublishedLineNumbers(WTPartMaster partMaster, View view)
          Returns a hash table of PublishedLineNumber objects associated with the given part number (i.e., WTPartMaster) in the given view.
 LineNumber getLatestLineNumber(WTPart part)
          Returns the largest line number assigned to the part.
 boolean hasLinksWithoutLineNumbers(WTPart assembly)
          Returns true if any of the usage links for the given assembly do not have line numbers..
 boolean isLineNumberPublished(LineNumber number, WTPartMaster part, View view)
          Returns true if the line number associated with the given part number (i.e., WTPartMaster) in the given view is published.
 boolean isLineNumberPublished(WTPartUsageLink usageLink)
          Returns true if the line number associated with the given part usage link has been published.
 void publishAllLineNumbers(WTPart part)
          Publish all the line numbers associated with each of the usage links for the given part assembly.
 void publishLineNumber(LineNumber number, WTPartMaster part, View view)
          Publishes the line number associated with the given part number (i.e., WTPartMaster) in the given view.
 void publishLineNumber(WTPartUsageLink usageLink)
          Publishes the line number associated with the given part usage link.
 void unpublishLineNumber(LineNumber number, WTPartMaster part, View view)
          Unpublishes the line number associated with the given part number (i.e., WTPartMaster) in the given view.
 void unpublishLineNumber(WTPartUsageLink usageLink)
          Unpublishes the line number associated with the given part usage link and its view.
 
Methods inherited from class wt.services.StandardManager
getManagerService, getManagerStatus, getName, getStartupType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getLatestLineNumber

public LineNumber getLatestLineNumber(WTPart part)
                               throws WTException
Returns the largest line number assigned to the part. The method takes at the largest line number assigned to the given part plus the largest line number published for the given part and returns the larger one to the caller.

Supported API: true

Specified by:
getLatestLineNumber in interface LineNumberService
Parameters:
part -
Returns:
LineNumber
Throws:
WTException

publishLineNumber

public void publishLineNumber(WTPartUsageLink usageLink)
                       throws WTException
Publishes the line number associated with the given part usage link. The line number must be unique given the parent part of the usage link and the view that it is in. This method throws a WTException if the uniqueness constraint is violated.

Supported API: true

Specified by:
publishLineNumber in interface LineNumberService
Parameters:
usageLink -
Throws:
WTException

publishLineNumber

public void publishLineNumber(LineNumber number,
                              WTPartMaster part,
                              View view)
                       throws WTException
Publishes the line number associated with the given part number (i.e., WTPartMaster) in the given view. The line number must be unique for the given part and view. This method throws a WTException if the uniqueness constraint is violated.

Supported API: true

Specified by:
publishLineNumber in interface LineNumberService
Parameters:
number -
part -
view -
Throws:
WTException

publishAllLineNumbers

public void publishAllLineNumbers(WTPart part)
                           throws WTException
Publish all the line numbers associated with each of the usage links for the given part assembly. A WTException is thrown if a uniqueness constraint is violated.

Supported API: true

Specified by:
publishAllLineNumbers in interface LineNumberService
Parameters:
part -
Throws:
WTException

isLineNumberPublished

public boolean isLineNumberPublished(WTPartUsageLink usageLink)
                              throws WTException
Returns true if the line number associated with the given part usage link has been published.

Supported API: true

Specified by:
isLineNumberPublished in interface LineNumberService
Parameters:
usageLink -
Returns:
boolean
Throws:
WTException

isLineNumberPublished

public boolean isLineNumberPublished(LineNumber number,
                                     WTPartMaster part,
                                     View view)
                              throws WTException
Returns true if the line number associated with the given part number (i.e., WTPartMaster) in the given view is published.

Supported API: true

Specified by:
isLineNumberPublished in interface LineNumberService
Parameters:
number -
part -
view -
Returns:
boolean
Throws:
WTException

unpublishLineNumber

public void unpublishLineNumber(WTPartUsageLink usageLink)
                         throws WTException
Unpublishes the line number associated with the given part usage link and its view.

Supported API: true

Specified by:
unpublishLineNumber in interface LineNumberService
Parameters:
usageLink -
Throws:
WTException

unpublishLineNumber

public void unpublishLineNumber(LineNumber number,
                                WTPartMaster part,
                                View view)
                         throws WTException
Unpublishes the line number associated with the given part number (i.e., WTPartMaster) in the given view. The line number must be unique for the given part and view. This method throws a WTException if the uniqueness constraint is violated.

Supported API: true

Specified by:
unpublishLineNumber in interface LineNumberService
Parameters:
number -
part -
view -
Throws:
WTException

hasLinksWithoutLineNumbers

public boolean hasLinksWithoutLineNumbers(WTPart assembly)
                                   throws WTException
Returns true if any of the usage links for the given assembly do not have line numbers..

Supported API: true

Specified by:
hasLinksWithoutLineNumbers in interface LineNumberService
Parameters:
assembly -
Returns:
boolean
Throws:
WTException

findAllPublishedLineNumbers

public Hashtable findAllPublishedLineNumbers(WTPartMaster partMaster,
                                             View view)
                                      throws WTException
Returns a hash table of PublishedLineNumber objects associated with the given part number (i.e., WTPartMaster) in the given view.

If ht is the hash table returned by this method, then the calling code can determine whether a given line number has been published by invoking the following method: ht.get(a_LineNumber). If the method returns a null, the specified line number is not published.

Supported API: true

Specified by:
findAllPublishedLineNumbers in interface LineNumberService
Parameters:
partMaster -
view -
Returns:
Hashtable
Throws:
WTException